SocketOption

Namespace: fszmq
Parent Module: Options

Settable socket options

Union Cases

Union Case	Description
`Affinity(bitmask)` Signature: uint64	I/O thread affinity bit-mask
`AuthenticationDomain(domain)` Signature: string	Sets authentication domain
`Backlog(length)` Signature: int	Maximum number of queued peers
`ConnectPeerId(byte [])` Signature: byte []	Sets the peer id of the next connected host, and immediately readies that connection for data transfer with the named id.
`CurveClient(...)` Signature: byte [] * byte [] * byte []	Public and private keys for client using CURVE security
`CurveServer(secretKey)` Signature: byte []	Make socket act as a server for CURVE security
`DoNoSilentlyDropMessages(bool)` Signature: bool	do not silently drop messages if sending high water mark is reached
`GssapiClient(principal,servicePrincipal)` Signature: string * string	Make socket act as a GSSAPI client.
`GssapiClientUnencripted(...)` Signature: string * string	Make socket act as a GSSAPI client, disabling encryption.
`GssapiServer(principal)` Signature: string	Make socket act as a GSSAPI server.
`GssapiServerUnencripted(principal)` Signature: string	Make socket act as a GSSAPI server, disabling encryption.
`HandshakeInterval(delay)` Signature: int<MeasureProduct<ms,MeasureOne>>	Sets the maximum handshake interval
`Identity(identifier)` Signature: byte []	Socket identifier
`Immediate(queueCompletedOnly)` Signature: bool	limit queuing to only completed connections
`Ipv6(ipv6)` Signature: bool	true to enable IPv6 on the socket, false to restrict to only IPv4
`KeepLastMessageInQueue(keepMessage)` Signature: bool	keep last message in queue (ignores high-water mark options)
`LingerDelay(delay)` Signature: int<MeasureProduct<ms,MeasureOne>>	Pause before shutdown
`MaxMessageSize(size)` Signature: int64<MeasureProduct<Byte,MeasureOne>>	Maximum inbound message size
`MaxReconnectInterval(delay)` Signature: int<MeasureProduct<ms,MeasureOne>>	Maximum reconnection interval
`MulticastHops(hops)` Signature: int<MeasureProduct<NetworkHop,MeasureOne>>	Time-to-live for each multicast packet
`MulticastRecovery(time)` Signature: int<MeasureProduct<ms,MeasureOne>>	Multicast recovery period
`NullSecurity` Signature:	make socket act as server or client for NULL security
`PlainClient(username,password)` Signature: string * string	Set user name and password for client using PLAIN security
`PlainServer` Signature:	make socket act as server for PLAIN security
`ProbeRouter(...)` Signature: bool	automatically send an empty message on new connection
`Rate(dataRate)` Signature: int<MeasureProduct<MeasureInverse<s>,MeasureProduct<kb,MeasureOne>>>	Multicast data rate
`ReceiveBuffer(...)` Signature: int<MeasureProduct<Byte,MeasureOne>>	Receive-message buffer size in bytes
`ReceiveQueue(size)` Signature: int	Maximum number of inbound queued messages
`ReceiveTimeout(timeout)` Signature: int<MeasureProduct<ms,MeasureOne>>	Timeout period for inbound messages
`ReconnectDelay(delay)` Signature: int<MeasureProduct<ms,MeasureOne>>	Pause before reconnect
`RelaxStrictAlternation(...)` Signature: bool	relax strict alternation between ZMQ.REQ and ZMQ.REP
`RequestCorrelation(...)` Signature: bool	prefix messages with explicit request ID
`ResendDuplicateMessages(resendDuplicate)` Signature: bool	resend duplicate messages
`RouterHandover(bool)` Signature: bool	If that option is set, the ROUTER socket shall hand-over the connection to the new client and disconnect the existing one.
`RouterMandatory(errorOnUnroutable)` Signature: bool	true to error on unroutable messages, false to silently ignore
`SendBuffer(size)` Signature: int<MeasureProduct<Byte,MeasureOne>>	Send-message buffer size in bytes
`SendQueue(size)` Signature: int	Maximum number of outbound queued messages
`SendTimeout(timeout)` Signature: int<MeasureProduct<ms,MeasureOne>>	Timeout period for outbound messages
`SocksProxy(string)` Signature: string	Connect through a SOCKS proxy
`Subscribe(filter)` Signature: byte []	Add subscription filter
`TcpKeepalive(enable)` Signature: bool option	Override OS-level TCP keep-alive
`TcpKeepaliveCount(count)` Signature: int	Override OS-level TCP keep-alive
`TcpKeepaliveIdle(idle)` Signature: int<MeasureProduct<s,MeasureOne>>	Override OS-level TCP keep-alive
`TcpKeepaliveInterval(delay)` Signature: int<MeasureProduct<s,MeasureOne>>	Override OS-level TCP keep-alive
`TypeOfService(int)` Signature: int	Sets the ToS fields (Differentiated services (DS) and Explicit Congestion Notification (ECN) field of the IP header. The ToS field is typically used to specify a packets priority.
`Unsubscribe(filter)` Signature: byte []	Remove subscription filter