Merge pull request #112 from nmittler/comments

Some comment cleanup in the Netty builders.
This commit is contained in:
Nathan Mittler 2015-02-24 13:17:47 -08:00
commit 494d273b05
2 changed files with 22 additions and 2 deletions

View File

@ -41,7 +41,7 @@ import java.net.InetSocketAddress;
import java.net.SocketAddress; import java.net.SocketAddress;
/** /**
* Convenient class for building channels with the netty transport. * A builder to help simplify construction of channels using the Netty transport.
*/ */
public final class NettyChannelBuilder extends AbstractChannelBuilder<NettyChannelBuilder> { public final class NettyChannelBuilder extends AbstractChannelBuilder<NettyChannelBuilder> {

View File

@ -46,7 +46,7 @@ import java.net.InetSocketAddress;
import java.net.SocketAddress; import java.net.SocketAddress;
/** /**
* The convenient builder for a netty-based GRPC server. * A builder to help simplify the construction of a Netty-based GRPC server.
*/ */
public final class NettyServerBuilder extends AbstractServerBuilder<NettyServerBuilder> { public final class NettyServerBuilder extends AbstractServerBuilder<NettyServerBuilder> {
@ -56,14 +56,34 @@ public final class NettyServerBuilder extends AbstractServerBuilder<NettyServerB
private EventLoopGroup userWorkerEventLoopGroup; private EventLoopGroup userWorkerEventLoopGroup;
private SslContext sslContext; private SslContext sslContext;
/**
* Creates a server builder that will bind to the given port.
*
* @param port the port on which the server is to be bound.
* @return the server builder.
*/
public static NettyServerBuilder forPort(int port) { public static NettyServerBuilder forPort(int port) {
return new NettyServerBuilder(port); return new NettyServerBuilder(port);
} }
/**
* Creates a server builder that will bind to the given port and use the {@link HandlerRegistry}
* for call dispatching.
*
* @param registry the registry of handlers used for dispatching incoming calls.
* @param port the port on which to the server is to be bound.
* @return the server builder.
*/
public static NettyServerBuilder forRegistryAndPort(HandlerRegistry registry, int port) { public static NettyServerBuilder forRegistryAndPort(HandlerRegistry registry, int port) {
return new NettyServerBuilder(registry, port); return new NettyServerBuilder(registry, port);
} }
/**
* Creates a server builder configured with the given {@link SocketAddress}.
*
* @param address the socket address on which the server is to be bound.
* @return the server builder
*/
public static NettyServerBuilder forAddress(SocketAddress address) { public static NettyServerBuilder forAddress(SocketAddress address) {
return new NettyServerBuilder(address); return new NettyServerBuilder(address);
} }