org.zeromq

Socket

class Socket extends MessageTransport[List[Array[Byte]], List[Array[Byte]]]

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

Linear Supertypes
MessageTransport[List[Array[Byte]], List[Array[Byte]]], Closeable, AutoCloseable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Socket
  2. MessageTransport
  3. Closeable
  4. AutoCloseable
  5. AnyRef
  6. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Socket(_socketType: Socket.Value)(implicit context: ZeroMQContext)

    _socketType

    Type of socket to create

    context

    Implicit ZeroMQ application context

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. def affinity: BitSet

    Bitmask defining the socket's I/O thread affinity.

  7. def affinity_=(v: BitSet): Unit

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def backlog: Int

    Maximum number of queued outstanding connections.

  10. def backlog_=(v: Int): Unit

  11. def bind(endpoint: String): Unit

    Bind the socket to a local endpoint.

    Bind the socket to a local endpoint.

    endpoint

    URL-like specification of local address

  12. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. def close(): Unit

    Close the socket.

    Close the socket. This is also called automatically when the object is finalized. The socket becomes unusable after the first successful call to this method, but it doesn't hurt to call the method again.

    Definition Classes
    SocketMessageTransport → Closeable → AutoCloseable
  14. def connect(endpoint: String): Unit

    Connect the socket to a remote endpoint.

    Connect the socket to a remote endpoint.

    endpoint

    URL-like specification of remote address.

  15. implicit val context: ZeroMQContext

    Implicit ZeroMQ application context

  16. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  18. def events: PollEvents

    Current polling state of the socket.

  19. def fileno: Int

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

  20. def finalize(): Unit

    Attributes
    protected[this]
    Definition Classes
    Socket → AnyRef
  21. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  22. def handle: Pointer

    The native handle for the socket.

  23. var hasPathPrefix: Boolean

    Whether the send and receive methods should process routing information prepended to payload message parts.

    Whether the send and receive methods should process routing information prepended to payload message parts. This is true by default for router sockets, false for all other socket types.

  24. var hasSeparatorPrefix: Boolean

    Whether the send and receive methods should add or remove an empty separator between the routing and payload message parts.

    Whether the send and receive methods should add or remove an empty separator between the routing and payload message parts. This is false by default but should be enabled for routers communicating with requestors or responders.

  25. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  26. def highWaterMark: Long

    Hard limit on the maximum number of outstanding messages queued in memory.

  27. def highWaterMark_=(v: Long): Unit

  28. def identity: Array[Byte]

    Application specific socket identifier.

  29. def identity_=(v: Array[Byte]): Unit

  30. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  31. def lingerPeriod: (Long, TimeUnit)

    Linger period for socket shutdown, as a time value with unit.

    Linger period for socket shutdown, as a time value with unit. Negative values are allowed and mean infinity.

  32. def lingerPeriod_=(v_u: (Long, TimeUnit)): Unit

  33. def maxReconnectInterval: (Long, TimeUnit)

    Maximum reconnection interval for lost connections, as a time value with unit.

  34. def maxReconnectInterval_=(v_u: (Long, TimeUnit)): Unit

  35. def multicastLoopback: Boolean

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

  36. def multicastLoopback_=(v: Boolean): Unit

  37. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  38. final def notify(): Unit

    Definition Classes
    AnyRef
  39. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  40. var pipeline: List[MessageTransform]

    Pipeline of transformations that are applied to outgoing and incoming messages.

    Pipeline of transformations that are applied to outgoing and incoming messages. The pipeline stages are applied from left to right when sending a message and from right to left when receiving a message.

  41. def rate: Long

    Maximum data rate for multicast transmissions, in kilobits per second.

  42. def rate_=(v: Long): Unit

  43. def receive(block: Boolean = true): (List[Array[Byte]], List[Array[Byte]])

    Receive a message through the transport.

    Receive a message through the transport.

    block

    Whether the operation should block (default: true)

    returns

    The incoming message and its routing path

    Definition Classes
    SocketMessageTransport
  44. def receiveBuffer: Long

    Kernel transmission buffer size when receiving.

  45. def receiveBuffer_=(v: Long): Unit

  46. def reconnectInterval: (Long, TimeUnit)

    Reconnection interval for lost connections, as a time value with unit.

  47. def reconnectInterval_=(v_u: (Long, TimeUnit)): Unit

  48. def send(message0: List[Array[Byte]], path0: List[Array[Byte]] = Nil, block: Boolean = true): Unit

    Send a message through the transport.

    Send a message through the transport.

    block

    Whether the operation should block (default: true)

    Definition Classes
    SocketMessageTransport
  49. def sendBuffer: Long

    Kernel transmission buffer size when sending.

  50. def sendBuffer_=(v: Long): Unit

  51. def socket: Socket

    The socket underlying this transport.

    The socket underlying this transport.

    Definition Classes
    SocketMessageTransport
  52. def socketType: Socket.Value

    Effective socket type.

  53. def subscribe(prefix: Array[Byte]): Unit

    Subscribe to messages with a given prefix.

    Subscribe to messages with a given prefix.

    prefix

    Buffer whose contents from start to limit form the prefix

  54. def swap: Long

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

  55. def swap_=(v: Long): Unit

  56. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  57. def toString(): String

    Definition Classes
    AnyRef → Any
  58. def tryReceive(): Option[(List[Array[Byte]], List[Array[Byte]])]

    Perform a non-blocking receive operation and report the blocking error condition through an empty return value.

    Perform a non-blocking receive operation and report the blocking error condition through an empty return value.

    returns

    Some message if the receive was successful, none if it would block

    Definition Classes
    MessageTransport
  59. def trySend(message: List[Array[Byte]], path: List[Array[Byte]] = Nil): Boolean

    Perform a non-blocking send operation and report the blocking error condition through a boolean return value.

    Perform a non-blocking send operation and report the blocking error condition through a boolean return value.

    message

    The message to transmit

    path

    Routing path for the message

    returns

    true if the send was successful, false if it would block

    Definition Classes
    MessageTransport
  60. def unsubscribe(prefix: Array[Byte]): Unit

    Unsubscribe to messages with a given prefix.

    Unsubscribe to messages with a given prefix.

    prefix

    Buffer whose contents from start to limit form the prefix

  61. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from MessageTransport[List[Array[Byte]], List[Array[Byte]]]

Inherited from Closeable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped