[Home] Type ZeroMQ.Socket


ZeroMQ socket. This class is not thread-safe, just like its underlying native backend.

Type Description

type Socket

Interfaces

Type
System.IDisposable

Constructors

MemberDescription
new Socket (context, socket_type)
context: ZeroMQContext
socket_type: SocketType
returns : Socket

Instance Members

MemberDescription
socket.Affinity : uint64
Bitmask defining the socket's I/O thread affinity.

socket.Affinity () <- v
Bitmask defining the socket's I/O thread affinity.

socket.Backlog : int
Maximum number of queued outstanding connections.

socket.Backlog () <- v
Maximum number of queued outstanding connections.

socket.Bind (endpoint)
Bind the socket to a local endpoint.
endpoint: string
returns : unit

socket.CanReceiveMore : bool
Whether there are more message parts to receive.

socket.Close ()
Close the socket. This is also called automatically when the object is disposed or finalized. The context becomes unusable after the first successful call to this method, but it doesn't hurt to call the method again.
returns : unit

socket.Connect (endpoint)
Bind the socket to a remote endpoint.
endpoint: string
returns : unit

socket.Fileno : int
A file descriptor that can be polled to check the status of this socket.

socket.Handle : nativeint
The native handle for the socket.

socket.HighWaterMark : uint64
Hard limit on the maximum number of outstanding messages queued in memory.

socket.HighWaterMark () <- v
Hard limit on the maximum number of outstanding messages queued in memory.

socket.Identity : byte []
Application specific socket identifier.

socket.Identity () <- v
Application specific socket identifier.

socket.LingerPeriod : float
Linger period for socket shutdown, in seconds but with millisecond granularity. Infinity is allowed as a value.

socket.LingerPeriod () <- v
Linger period for socket shutdown, in seconds but with millisecond granularity. Infinity is allowed as a value.

socket.MaxReconnectInterval : float
Maximum reconnection interval for lost connections, in seconds with millisecond granularity.

socket.MaxReconnectInterval () <- v
Maximum reconnection interval for lost connections, in seconds with millisecond granularity.

socket.MulticastLoopback : bool
Whether data sent in a multicast transmission can be received by the sender, too.

socket.MulticastLoopback () <- v
Whether data sent in a multicast transmission can be received by the sender, too.

socket.PendingEvents : SocketEvents
Current polling state of the socket.

socket.Poll (watch_events, ?timeout)
Poll a single socket for its I/O state. The timeout is given in seconds with microsecond resolution, it defaults to infinity. The method returns the pending events.
watch_events: SocketEvents
?timeout: float option
returns : SocketEvents

socket.Rate : int64
Maximum data rate for multicast transmissions, in kilobits per second.

socket.Rate () <- v
Maximum data rate for multicast transmissions, in kilobits per second.

socket.Receive (?flags)
Receive a message through the socket. Returns a freshly allocated data buffer containing the message.
?flags: MessageFlags option
returns : byte []

socket.Receive (data, ?start, ?flags)
Receive a message through the socket. The given data buffer, if any, is used if it has enough space for the message. In other cases a fresh data buffer is created and the prefix of data, if any, is copied from the given buffer. The method returns the number of bytes that have been received.
data: byref<byte []>
?start: int option
?flags: MessageFlags option
returns : int

socket.ReceiveBuffer : uint64
Kernel transmission buffer size when receiving.

socket.ReceiveBuffer () <- v
Kernel transmission buffer size when receiving.

socket.ReconnectInterval : float
Reconnection interval for lost connections, in seconds with millisecond granularity.

socket.ReconnectInterval () <- v
Reconnection interval for lost connections, in seconds with millisecond granularity.

socket.RecoveryInterval : float
Maximum recovery timeout for multicast transmissions, in seconds but with millisecond granularity.

socket.RecoveryInterval () <- v
Maximum recovery timeout for multicast transmissions, in seconds but with millisecond granularity.

socket.Send (data, ?start, ?length, ?flags)
Send a message through the socket.
data: byte []
?start: int option
?length: int option
?flags: MessageFlags option
returns : unit

socket.SendBuffer : uint64
Kernel transmission buffer size when sending.

socket.SendBuffer () <- v
Kernel transmission buffer size when sending.

socket.SocketType : SocketType
Effective socket type.

socket.Subscribe (prefix)
Subscribe to messages with a given prefix.
prefix: byte []
returns : unit

socket.Swap : int64
Size of disk buffers for outstanding messages that exceed the high water mark of the in-memory queue.

socket.Swap () <- v
Size of disk buffers for outstanding messages that exceed the high water mark of the in-memory queue.

socket.Unsubscribe (prefix)
Unsubscribe to messages with a given prefix.
prefix: byte []
returns : unit

Static Members

MemberDescription
Socket.Poll (items, ?timeout)
Poll a number of sockets or file descriptors for their I/O state. The timeout is given in seconds with microsecond resolution, it defaults to infinity. The method returns the number of items for which events have been observed.
items: PollItem []
?timeout: float option
returns : int

See Also

ZeroMQ


Documentation for assembly ZeroMQ, version 1.0.4999.0, generated using the F# Programming Power Pack