net.kuujo.copycat.vertx

Class VertxTcpProtocol

java.lang.Object

net.kuujo.copycat.util.AbstractConfigurable

net.kuujo.copycat.protocol.AbstractProtocol

net.kuujo.copycat.vertx.VertxTcpProtocol

All Implemented Interfaces:

Protocol, Configurable, Copyable<Configurable>

public class VertxTcpProtocol
extends AbstractProtocol

TCP based protocol.

Author:

Jordan Halterman

Field Summary

Fields inherited from class net.kuujo.copycat.util.AbstractConfigurable

config

Constructor Summary

Constructors

Constructor and Description
VertxTcpProtocol()
VertxTcpProtocol(Map<String,Object> config)
VertxTcpProtocol(String resource)
VertxTcpProtocol(io.vertx.core.Vertx vertx)

Method Summary

Modifier and Type	Method and Description
VertxTcpProtocol	copy()
ProtocolClient	createClient(URI uri)
ProtocolServer	createServer(URI uri)
int	getAcceptBacklog() Returns the accept backlog.
int	getConnectTimeout() Returns the connection timeout.
int	getReceiveBufferSize() Returns the receive buffer size.
int	getSendBufferSize() Returns the send buffer size.
io.vertx.core.Vertx	getVertx() Returns the Vert.x instance.
boolean	isClientAuthRequired() Returns whether client authentication is required.
boolean	isClientTrustAll() Returns whether to trust all server certs.
boolean	isSsl() Returns a boolean indicating whether SSL encryption is enabled.
void	setAcceptBacklog(int backlog) Sets the accept backlog.
void	setClientAuthRequired(boolean required) Sets whether client authentication is required.
void	setClientTrustAll(boolean trustAll) Sets whether to trust all server certs.
void	setConnectTimeout(int connectTimeout) Sets the connection timeout.
void	setReceiveBufferSize(int bufferSize) Sets the receive buffer size.
void	setSendBufferSize(int bufferSize) Sets the send buffer size.
void	setSsl(boolean useSsl) Sets whether to use SSL encryption.
void	setVertx(io.vertx.core.Vertx vertx) Sets the Vert.x instance.
VertxTcpProtocol	withAcceptBacklog(int backlog) Sets the accept backlog, returning the protocol for method chaining.
VertxTcpProtocol	withClientAuthRequired(boolean required) Sets whether client authentication is required.
VertxTcpProtocol	withClientTrustAll(boolean trustAll) Sets whether to trust all server certs, returning the protocol for method chaining.
VertxTcpProtocol	withConnectTimeout(int connectTimeout) Sets the connection timeout, returning the protocol for method chaining.
VertxTcpProtocol	withReceiveBufferSize(int bufferSize) Sets the receive buffer size, returning the protocol for method chaining.
VertxTcpProtocol	withSendBufferSize(int bufferSize) Sets the send buffer size, returning the protocol for method chaining.
VertxTcpProtocol	withSsl(boolean useSsl) Sets whether to use SSL encryption, returning the protocol for method chaining.
VertxTcpProtocol	withVertx(io.vertx.core.Vertx vertx) Sets the Vert.x instance, returning the configuration for method chaining.

Methods inherited from class net.kuujo.copycat.util.AbstractConfigurable

addResources, configure, equals, hashCode, toMap, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.kuujo.copycat.protocol.Protocol

isValidUri

Methods inherited from interface net.kuujo.copycat.util.Configurable

configure, load, toMap

Constructor Detail

VertxTcpProtocol

public VertxTcpProtocol()

VertxTcpProtocol

public VertxTcpProtocol(io.vertx.core.Vertx vertx)

VertxTcpProtocol

public VertxTcpProtocol(Map<String,Object> config)

VertxTcpProtocol

public VertxTcpProtocol(String resource)

Method Detail

copy

public VertxTcpProtocol copy()

Specified by:

copy in interface Copyable<Configurable>

Overrides:

copy in class AbstractConfigurable

setVertx

public void setVertx(io.vertx.core.Vertx vertx)

Sets the Vert.x instance.

Parameters:

vertx - The Vert.x instance.

getVertx

public io.vertx.core.Vertx getVertx()

Returns the Vert.x instance.

Returns:

The Vert.x instance.

withVertx

public VertxTcpProtocol withVertx(io.vertx.core.Vertx vertx)

Sets the Vert.x instance, returning the configuration for method chaining.

Parameters:

vertx - The Vert.x instance.

Returns:

The TCP protocol.

setSendBufferSize

public void setSendBufferSize(int bufferSize)

Sets the send buffer size.

Parameters:

bufferSize - The send buffer size.

Throws:

IllegalArgumentException - If the buffer size is not positive

getSendBufferSize

public int getSendBufferSize()

Returns the send buffer size.

Returns:

The send buffer size.

withSendBufferSize

public VertxTcpProtocol withSendBufferSize(int bufferSize)

Sets the send buffer size, returning the protocol for method chaining.

Parameters:

bufferSize - The send buffer size.

Returns:

The TCP protocol.

Throws:

IllegalArgumentException - If the buffer size is not positive

setReceiveBufferSize

public void setReceiveBufferSize(int bufferSize)

Sets the receive buffer size.

Parameters:

bufferSize - The receive buffer size.

Throws:

IllegalArgumentException - If the buffer size is not positive

getReceiveBufferSize

public int getReceiveBufferSize()

Returns the receive buffer size.

Returns:

The receive buffer size.

withReceiveBufferSize

public VertxTcpProtocol withReceiveBufferSize(int bufferSize)

Sets the receive buffer size, returning the protocol for method chaining.

Parameters:

bufferSize - The receive buffer size.

Returns:

The TCP protocol.

Throws:

IllegalArgumentException - If the buffer size is not positive

setSsl

public void setSsl(boolean useSsl)

Sets whether to use SSL encryption.

Parameters:

useSsl - Whether to use SSL encryption.

isSsl

public boolean isSsl()

Returns a boolean indicating whether SSL encryption is enabled.

Returns:

Indicates whether SSL encryption is enabled.

withSsl

public VertxTcpProtocol withSsl(boolean useSsl)

Sets whether to use SSL encryption, returning the protocol for method chaining.

Parameters:

useSsl - Whether to use SSL encryption.

Returns:

The TCP protocol.

setClientTrustAll

public void setClientTrustAll(boolean trustAll)

Sets whether to trust all server certs.

Parameters:

trustAll - Whether to trust all server certs.

isClientTrustAll

public boolean isClientTrustAll()

Returns whether to trust all server certs.

Returns:

Whether to trust all server certs.

withClientTrustAll

public VertxTcpProtocol withClientTrustAll(boolean trustAll)

Sets whether to trust all server certs, returning the protocol for method chaining.

Parameters:

trustAll - Whether to trust all server certs.

Returns:

The TCP protocol.

setClientAuthRequired

public void setClientAuthRequired(boolean required)

Sets whether client authentication is required.

Parameters:

required - Whether client authentication is required.

isClientAuthRequired

public boolean isClientAuthRequired()

Returns whether client authentication is required.

Returns:

Whether client authentication is required.

withClientAuthRequired

public VertxTcpProtocol withClientAuthRequired(boolean required)

Sets whether client authentication is required.

Parameters:

required - Whether client authentication is required.

Returns:

The TCP protocol.

setAcceptBacklog

public void setAcceptBacklog(int backlog)

Sets the accept backlog.

Parameters:

backlog - The accept backlog.

Throws:

IllegalArgumentException - If the accept backlog is not positive

getAcceptBacklog

public int getAcceptBacklog()

Returns the accept backlog.

Returns:

The accept backlog.

withAcceptBacklog

public VertxTcpProtocol withAcceptBacklog(int backlog)

Sets the accept backlog, returning the protocol for method chaining.

Parameters:

backlog - The accept backlog.

Returns:

The TCP protocol.

Throws:

IllegalArgumentException - If the accept backlog is not positive

setConnectTimeout

public void setConnectTimeout(int connectTimeout)

Sets the connection timeout.

Parameters:

connectTimeout - The connection timeout.

Throws:

IllegalArgumentException - If the connect timeout is not positive

getConnectTimeout

public int getConnectTimeout()

Returns the connection timeout.

Returns:

The connection timeout.

withConnectTimeout

public VertxTcpProtocol withConnectTimeout(int connectTimeout)

Sets the connection timeout, returning the protocol for method chaining.

Parameters:

connectTimeout - The connection timeout.

Returns:

The TCP protocol.

Throws:

IllegalArgumentException - If the connect timeout is not positive

createServer

public ProtocolServer createServer(URI uri)

createClient

public ProtocolClient createClient(URI uri)