API

TransportTcpServerConfiguration

Parameters

Name	Type	Description	Defaults
readTimeout	Duration	Timeout for socket read operations	∞
writeTimeout	Duration	Timeout for socket write operations	∞
socketMaxConnections	int?	N connection requests will be queued before further requests are refused	4096
socketReceiveBufferSize	int?	SO_RCVBUF	4 * 1024 * 1024
socketSendBufferSize	int?	SO_SNDBUF	4 * 1024 * 1024
socketNonblock	bool?	O_NONBLOCK	true
socketCloexec	bool?	O_CLOEXEC	true
socketReusePort	bool?	SO_REUSEPORT	true
socketReuseAddress	bool?	SO_REUSEADDR
socketKeepalive	bool?	SO_KEEPALIVE
socketReceiveLowAt	int?	SO_RCVLOWAT
socketSendLowAt	int?	SO_SNDLOWAT
tcpQuickack	bool?	TCP_QUICKACK	true
tcpDeferAccept	bool?	TCP_DEFER_ACCEPT	true
tcpNoDelay	bool?	TCP_NODELAY	true
tcpFastopen	bool?	TCP_FASTOPEN	true
ipTtl	int?	IP_TTL
ipFreebind	bool?	IP_FREEBIND
tcpKeepAliveIdle	int?	TCP_KEEPIDLE
tcpKeepAliveMaxCount	int?	TCP_KEEPCNT
tcpKeepAliveIndividualCount	int?	TCP_KEEPINTVL
tcpMaxSegmentSize	int?	TCP_MAXSEG
tcpSynCount	int?	TCP_SYNCNT

TransportTcpClientConfiguration

Parameters

Name	Type	Description	Defaults
pool	int	Connections in the pool	1
connectTimeout	Duration	Timeout for connect operations	Duration(seconds: 60)
readTimeout	Duration	Timeout for socket read operations	Duration(seconds: 60)
writeTimeout	Duration	Timeout for socket write operations	Duration(seconds: 60)
socketReceiveBufferSize	int?	SO_RCVBUF	4 * 1024 * 1024
socketSendBufferSize	int?	SO_SNDBUF	4 * 1024 * 1024
socketNonblock	bool?	O_NONBLOCK	true
socketCloexec	bool?	O_CLOEXEC	true
socketReuseAddress	bool?	SO_REUSEPORT
socketReusePort	bool?	SO_REUSEADDR
socketKeepalive	bool?	SO_KEEPALIVE
socketReceiveLowAt	int?	SO_RCVLOWAT
socketSendLowAt	int?	SO_SNDLOWAT
tcpQuickack	bool?	TCP_QUICKACK	true
tcpDeferAccept	bool?	TCP_DEFER_ACCEPT	true
tcpFastopen	bool?	TCP_NODELAY	true
tcpNoDelay	bool?	TCP_FASTOPEN	true
ipTtl	int?	IP_TTL
ipFreebind	bool?	IP_FREEBIND
tcpKeepAliveIdle	int?	TCP_KEEPIDLE
tcpKeepAliveMaxCount	int?	TCP_KEEPCNT
tcpKeepAliveIndividualCount	int?	TCP_KEEPINTVL
tcpMaxSegmentSize	int?	TCP_MAXSEG
tcpSynCount	int?	TCP_SYNCNT

TransportUdpServerConfiguration

Parameters

Name	Type	Description	Defaults
readTimeout	Duration	Timeout for socket read operations	∞
writeTimeout	Duration	Timeout for socket write operations	∞
socketReceiveBufferSize	int?	SO_RCVBUF	4 * 1024 * 1024
socketSendBufferSize	int?	SO_SNDBUF	4 * 1024 * 1024
socketNonblock	bool?	O_NONBLOCK	true
socketCloexec	bool?	O_CLOEXEC	true
socketReusePort	bool?	SO_REUSEPORT	true
socketReuseAddress	bool?	SO_REUSEADDR
socketBroadcast	bool?	SO_KEEPALIVE
socketReceiveLowAt	int?	SO_RCVLOWAT
socketSendLowAt	int?	SO_SNDLOWAT
ipTtl	int?	IP_TTL
ipFreebind	bool?	IP_FREEBIND
ipMulticastAll	bool?	IP_MULTICAST_ALL
ipMulticastInterface	TransportUdpMulticastConfiguration?	IP UDP Multicast Interface parameters
ipMulticastLoop	int?	IP_MULTICAST_LOOP
ipMulticastTtl	int?	IP_MULTICAST_TTL
multicastManager	TransportUdpMulticastManager?	Manager for controlling multicast interfaces

TransportUdpClientConfiguration

Parameters

Name	Type	Description	Defaults
readTimeout	Duration	Timeout for socket read operations	Duration(seconds: 60)
writeTimeout	Duration	Timeout for socket write operations	Duration(seconds: 60)
socketReceiveBufferSize	int?	SO_RCVBUF	4 * 1024 * 1024
socketSendBufferSize	int?	SO_SNDBUF	4 * 1024 * 1024
socketNonblock	bool?	O_NONBLOCK	true
socketCloexec	bool?	O_CLOEXEC	true
socketReuseAddress	bool?	SO_REUSEPORT
socketReusePort	bool?	SO_REUSEADDR
socketBroadcast	bool?	SO_KEEPALIVE
socketReceiveLowAt	int?	SO_RCVLOWAT
socketSendLowAt	int?	SO_SNDLOWAT
ipTtl	int?	IP_TTL
ipFreebind	bool?	IP_FREEBIND
ipMulticastAll	bool?	IP_MULTICAST_ALL
ipMulticastInterface	TransportUdpMulticastConfiguration?	IP UDP Multicast Interface parameters
ipMulticastLoop	int?	IP_MULTICAST_LOOP
ipMulticastTtl	int?	IP_MULTICAST_TTL
multicastManager	TransportUdpMulticastManager?	Manager for controlling multicast interfaces

TransportUdpMulticastConfiguration

Parameters

Name	Type	Description
groupAddress	String	ip_mreqn
localAddress	String	ip_mreqn
localInterface	String?	ip_mreqn
interfaceIndex	int?	ip_mreqn
calculateInterfaceIndex	bool	Take the local interface index from the local interface name

TransportUdpMulticastManager

Declaration

class TransportUdpMulticastManager {
  void addMembership(TransportUdpMulticastConfiguration configuration)
  void dropMembership(TransportUdpMulticastConfiguration configuration)
  void addSourceMembership(TransportUdpMulticastSourceConfiguration configuration)
  void dropSourceMembership(TransportUdpMulticastSourceConfiguration configuration)
}

Methods

addMembership

See IP_ADD_MEMBERSHIP.

dropMembership

See IP_DROP_MEMBERSHIP.

addSourceMembership

See IP_ADD_SOURCE_MEMBERSHIP.

dropSourceMembership

See IP_DROP_SOURCE_MEMBERSHIP.

TransportUdpMulticastSourceConfiguration

Parameters

Name	Type	Description
groupAddress	String	ip_mreq_source
localAddress	String	ip_mreq_source
sourceAddress	String	ip_mreq_source

TransportUnixStreamClientConfiguration

Parameters

Name	Type	Description	Defaults
pool	int	Connections in the pool	1
connectTimeout	Duration	Timeout for connect operations	Duration(seconds: 60)
readTimeout	Duration	Timeout for socket read operations	Duration(seconds: 60)
writeTimeout	Duration	Timeout for socket write operations	Duration(seconds: 60)
socketReceiveBufferSize	int?	SO_RCVBUF	4 * 1024 * 1024
socketSendBufferSize	int?	SO_SNDBUF	4 * 1024 * 1024
socketNonblock	bool?	O_NONBLOCK	true
socketCloexec	bool?	O_CLOEXEC	true
socketKeepalive	bool?	SO_KEEPALIVE
socketReceiveLowAt	int?	SO_RCVLOWAT
socketSendLowAt	int?	SO_SNDLOWAT

TransportUnixStreamServerConfiguration

Parameters

Name	Type	Description	Defaults
readTimeout	Duration	Timeout for socket read operations	∞
writeTimeout	Duration	Timeout for socket write operations	∞
socketReceiveBufferSize	int?	SO_RCVBUF	4 * 1024 * 1024
socketSendBufferSize	int?	SO_SNDBUF	4 * 1024 * 1024
socketNonblock	bool?	O_NONBLOCK	true
socketCloexec	bool?	O_CLOEXEC	true
socketKeepalive	bool?	SO_KEEPALIVE
socketReceiveLowAt	int?	SO_RCVLOWAT
socketSendLowAt	int?	SO_SNDLOWAT

TransportWorkerConfiguration

Parameters

Name	Type	Description	Defaults
buffersCount	int	io_uring mapped buffers count	4096
bufferSize	int	io_uring single buffer size	4096
ringSize	int	io_uring setup size	16384
ringFlags	int	io_uring setup size	0
timeoutCheckerPeriod	Duration	How often to check for the timed out events	Duration(milliseconds: 500)
delayRandomizationFactor	double	Multiplier to a random value used for idle delay calculation	0.25
cqePeekCount	int	How long CQEs to peek on each loop iteration?	1024
cqeWaitCount	int	How long CQEs wait on each loop iteration?	1
cqeWaitTimeout	Duration	How long to wait for new CQEs?	Duration(milliseconds: 1)
baseDelay	Duration	Default (mandatory) idle delay between loop operations	Duration(microseconds: 10)
maxDelay	Duration	Maximal idle delay between loop iteration	Duration(seconds: 5)
trace	bool	Enable/Disable event tracing	false