General Description

Provides classes to build applications that communicate through a NetSwitch server. The most important classes are ClientChannel and ServerChannel, which are used to build client and server applications, respectively.

ClientChannel Class

Bi-directional client communication channel with a NetSwitch server.

The following table describes the configuration parameters of a ClientChannel:

Property	Description	Type	Default
netswitch.client.«name».channel.password	Password use to authenticate the client channel	string	none
netswitch.client.«name».keep.alive	Enable or disable the socket SO_KEEPALIVE option	bool	false
netswitch.client.«name».reply.timeout	Maximum time to wait for reply of connect message (milliseconds)	int	10000
netswitch.client.«name».reader.buffer.free	Free size of the reader buffer (bytes)	int	4096
netswitch.client.«name».reader.buffer.max	Maximum size of the reader buffer (bytes)	int	0 (unbounded)
netswitch.client.«name».reader.buffer.min	Minimum size of the reader buffer (bytes)	int	8192
netswitch.client.«name».reader.buffer.warn	Warning size of the reader buffer (bytes)	int	8192
netswitch.client.«name».switch.uri	Protocol, address and port of the NetSwitch server	string	NETSWITCH
netswitch.client.«name».tcp.nodelay	Enable or disable the socket TCP_NODELAY option	bool	true
netswitch.client.«name».trace	Trace inbound and outbound messages (for debugging)	bool	false
netswitch.client.«name».trust.store.path	Path of the PFX/PKCS12 trust store file used for SSL/TLS connections	string	none
netswitch.client.«name».trust.store.pass	Password of the PFX/PKCS12 trust store file used for SSL/TLS connections	string	none
netswitch.client.«name».user.name	Username used to login the channel with the NetSwitch server	string	none
netswitch.client.«name».user.password	Password used to login the channel with the NetSwitch server	string	none

ServerChannel Class

Allows an application to provide services via a NetSwitch server.

The following table describes the configuration parameters of a ServerChannel:

Property	Description	Type	Default
netswitch.uri	Protocol, address and port of the NetSwitch server	string	NETSWITCH
netswitch.password	Password use to authenticate the server channel	string	none
netswitch.server.keep.alive	Enable or disable the socket SO_KEEPALIVE option	bool	false
netswitch.server.reader.buffer.free	Free size of the reader buffer (bytes)	int	4096
netswitch.server.reader.buffer.max	Maximum size of the reader buffer (bytes)	int	0 (unbounded)
netswitch.server.reader.buffer.min	Minimum size of the reader buffer (bytes)	int	8192
netswitch.server.reader.buffer.warn	Warning size of the reader buffer (bytes)	int	8192
netswitch.server.reply.timeout	Maximum time to wait for a NetSwitch reply (milliseconds)	int	800
netswitch.server.tcp.nodelay	Enable or disable the socket TCP_NODELAY option	bool	true
netswitch.server.trace	Trace inbound and outbound messages (for debugging)	bool	false
netswitch.server.trust.store	Path of the JKS trust store file used for SSL connections	string	none
netswitch.server.writer.queue.size	Maximum size of the writer queue (messages)	int	64