akka

zeromq

package zeromq

A package object with an implicit conversion for the actor system as a convenience

Source
package.scala
Linear Supertypes
Content Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. zeromq
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. case class Affinity(value: Long) extends SocketOption with Product with Serializable

    The akka.zeromq.Affinity option shall set the I/O thread affinity for newly created connections on the specified socket.

    The akka.zeromq.Affinity option shall set the I/O thread affinity for newly created connections on the specified socket.

    Affinity determines which threads from the ØMQ I/O thread pool associated with the socket's context shall handle newly created connections. A value of zero specifies no affinity, meaning that work shall be distributed fairly among all ØMQ I/O threads in the thread pool. For non-zero values, the lowest bit corresponds to thread 1, second lowest bit to thread 2 and so on. For example, a value of 3 specifies that subsequent connections on socket shall be handled exclusively by I/O threads 1 and 2.

    value

  2. case class Backlog(value: Long) extends SocketOption with Product with Serializable

    The akka.zeromq.Backlog option shall set the maximum length of the queue of outstanding peer connections for the specified socket; this only applies to connection-oriented transports.

    The akka.zeromq.Backlog option shall set the maximum length of the queue of outstanding peer connections for the specified socket; this only applies to connection-oriented transports. For details refer to your operating system documentation for the listen function.

    value

  3. case class Bind(endpoint: String) extends SocketConnectOption with Product with Serializable

    Start listening with this server socket on the specified address

    Start listening with this server socket on the specified address

    endpoint

  4. case class Connect(endpoint: String) extends SocketConnectOption with Product with Serializable

    This socket should be a client socket and connect to the specified endpoint

    This socket should be a client socket and connect to the specified endpoint

    endpoint

    URI (ex. tcp://127.0.0.1:5432)

  5. class Context extends SocketMeta

    Represents an I/O thread pool for ZeroMQ sockets.

    Represents an I/O thread pool for ZeroMQ sockets. By default the ZeroMQ module uses an I/O thread pool with 1 thread. For most applications that should be sufficient

  6. trait Deserializer extends SocketOption

    A base trait for message deserializers

  7. case class HighWatermark(value: Long) extends SocketOption with Product with Serializable

    The akka.zeromq.HighWatermark option shall set the high water mark for the specified socket.

    The akka.zeromq.HighWatermark option shall set the high water mark for the specified socket. The high water mark is a hard limit on the maximum number of outstanding messages ØMQ shall queue in memory for any single peer that the specified socket is communicating with.

    If this limit has been reached the socket shall enter an exceptional state and depending on the socket type, ØMQ shall take appropriate action such as blocking or dropping sent messages. The default akka.zeromq.HighWatermark value of zero means "no limit".

    value

  8. case class Identity(value: Array[Byte]) extends SocketOption with Product with Serializable

    Sets the identity of the specified socket.

    Sets the identity of the specified socket. Socket identity determines if existing ØMQ infrastructure (message queues, forwarding devices) shall be identified with a specific application and persist across multiple runs of the application.

    If the socket has no identity, each run of an application is completely separate from other runs. However, with identity set the socket shall re-use any existing ØMQ infrastructure configured by the previous run(s). Thus the application may receive messages that were sent in the meantime, message queue limits shall be shared with previous run(s) and so on.

    Identity should be at least one byte and at most 255 bytes long. Identities starting with binary zero are reserved for use by ØMQ infrastructure.

    value

    The identity string for this socket

  9. case class Linger(value: Long) extends SocketOption with Product with Serializable

    Configure this socket to have a linger of the specified value

    Configure this socket to have a linger of the specified value

    The linger period determines how long pending messages which have yet to be sent to a peer shall linger in memory after a socket is closed, and further affects the termination of the socket's context.

    The following outlines the different behaviours:

    • The default value of -1 specifies an infinite linger period. Pending messages shall not be discarded after the socket is closed; attempting to terminate the socket's context shall block until all pending messages have been sent to a peer.
    • The value of 0 specifies no linger period. Pending messages shall be discarded immediately when the socket is closed.
    • Positive values specify an upper bound for the linger period in milliseconds. Pending messages shall not be discarded after the socket is closed; attempting to terminate the socket's context shall block until either all pending messages have been sent to a peer, or the linger period expires, after which any pending messages shall be discarded.
    value

    The value in milliseconds for the linger option

  10. case class Listener(listener: ActorRef) extends SocketMeta with Product with Serializable

    An option containing the listener for the socket

    An option containing the listener for the socket

    listener

  11. case class MaxMsgSize(value: Long) extends SocketOption with Product with Serializable

    Limits the size of the inbound message.

    Limits the size of the inbound message. If a peer sends a message larger than akka.zeromq.MaxMsgSize it is disconnected. Value of -1 means no limit.

    This is a ZeroMQ 3.0 option

    value

  12. case class MulticastHops(value: Long) extends SocketOption with Product with Serializable

    Sets the time-to-live field in every multicast packet sent from this socket.

    Sets the time-to-live field in every multicast packet sent from this socket. The default is 1 which means that the multicast packets don't leave the local network.

    This is za ZeroMQ 3.0 option

    value

  13. case class MulticastLoop(value: Boolean) extends SocketOption with Product with Serializable

    Controls whether data sent via multicast transports using the specified socket can also be received by the sending host via loop-back.

    Controls whether data sent via multicast transports using the specified socket can also be received by the sending host via loop-back. A value of zero disables the loop-back functionality, while the default value of 1 enables the loop-back functionality. Leaving multicast loop-back enabled when it is not required can have a negative impact on performance. Where possible, disable McastLoop in production environments.

    value

    Flag indicating whether or not loopback multicast is enabled

  14. case class PollDispatcher(name: String) extends SocketMeta with Product with Serializable

    An option containing the configuration key for the poller loop dispatcher

    An option containing the configuration key for the poller loop dispatcher

    name

  15. case class PollTimeoutDuration(duration: FiniteDuration = 100 millis) extends SocketMeta with Product with Serializable

    An option containing the duration a poll cycle should wait for a message before it loops

    An option containing the duration a poll cycle should wait for a message before it loops

    duration

  16. sealed trait PubSubOption extends SocketOption

    A base trait for pubsub options for the ZeroMQ socket

  17. case class Rate(value: Long) extends SocketOption with Product with Serializable

    Sets the maximum send or receive data rate for multicast transports such as pgm using the specified socket.

    Sets the maximum send or receive data rate for multicast transports such as pgm using the specified socket.

    value

    The kilobits per second

  18. case class ReceiveBufferSize(value: Long) extends SocketOption with Product with Serializable

    The akka.zeromq.ReceiveBufferSize option shall set the underlying kernel receive buffer size for the socket to the specified size in bytes.

    The akka.zeromq.ReceiveBufferSize option shall set the underlying kernel receive buffer size for the socket to the specified size in bytes. A value of zero means leave the OS default unchanged. For details refer to your operating system documentation for the SO_RCVBUF socket option.

    value

  19. case class ReceiveHighWatermark(value: Long) extends SocketOption with Product with Serializable

    The akka.zeromq.ReceiveHighWatermark option shall set the high water mark for inbound messages on the specified socket.

    The akka.zeromq.ReceiveHighWatermark option shall set the high water mark for inbound messages on the specified socket. The high water mark is a hard limit on the maximum number of outstanding messages ØMQ shall queue in memory for any single peer that the specified socket is communicating with.

    If this limit has been reached the socket shall enter an exceptional state and depending on the socket type, ØMQ shall take appropriate action such as blocking or dropping sent messages.

    This is a ZeroMQ 3.0 option

    value

  20. case class ReconnectIVL(value: Long) extends SocketOption with Product with Serializable

    Sets the recovery interval for multicast transports using the specified socket.

    Sets the recovery interval for multicast transports using the specified socket. The recovery interval determines the maximum time in seconds that a receiver can be absent from a multicast group before unrecoverable data loss will occur.

    Exercise care when setting large recovery intervals as the data needed for recovery will be held in memory. For example, a 1 minute recovery interval at a data rate of 1Gbps requires a 7GB in-memory buffer.

    value

    The interval in seconds

  21. case class ReconnectIVLMax(value: Long) extends SocketOption with Product with Serializable

    The akka.zeromq.ReconnectIVLMax option shall set the maximum reconnection interval for the specified socket.

    The akka.zeromq.ReconnectIVLMax option shall set the maximum reconnection interval for the specified socket. This is the maximum period ØMQ shall wait between attempts to reconnect. On each reconnect attempt, the previous interval shall be doubled untill akka.zeromq.ReconnectIVLMax is reached. This allows for exponential backoff strategy. Default value means no exponential backoff is performed and reconnect interval calculations are only based on akka.zeromq.ReconnectIVL.

    value

    See also

    akka.zeromq.ReconnectIVL

    This is a ZeroMQ 3.0 option

  22. case class RecoveryInterval(value: Long) extends SocketOption with Product with Serializable

    Sets the recovery interval for multicast transports using the specified socket.

    Sets the recovery interval for multicast transports using the specified socket. The recovery interval determines the maximum time in seconds that a receiver can be absent from a multicast group before unrecoverable data loss will occur.

    Exercise care when setting large recovery intervals as the data needed for recovery will be held in memory. For example, a 1 minute recovery interval at a data rate of 1Gbps requires a 7GB in-memory buffer.

    value

    The interval in seconds

  23. sealed trait Request extends AnyRef

    Marker trait representing request messages for zeromq

  24. sealed trait Response extends AnyRef

    Base trait for the events raised by a ZeroMQ socket actor

  25. case class Send(frames: Seq[ByteString]) extends Request with Product with Serializable

    Send a message over the zeromq socket

    Send a message over the zeromq socket

    frames

  26. case class SendBufferSize(value: Long) extends SocketOption with Product with Serializable

    The akka.zeromq.SendBufferSize option shall set the underlying kernel transmit buffer size for the socket to the specified size in bytes.

    The akka.zeromq.SendBufferSize option shall set the underlying kernel transmit buffer size for the socket to the specified size in bytes. A value of zero means leave the OS default unchanged. For details please refer to your operating system documentation for the SO_SNDBUF socket option.

    This is a ZeroMQ 2.x only option

    value

  27. case class SendHighWatermark(value: Long) extends SocketOption with Product with Serializable

    The akka.zeromq.SendHighWatermark option shall set the high water mark for outbound messages on the specified socket.

    The akka.zeromq.SendHighWatermark option shall set the high water mark for outbound messages on the specified socket. The high water mark is a hard limit on the maximum number of outstanding messages ØMQ shall queue in memory for any single peer that the specified socket is communicating with.

    If this limit has been reached the socket shall enter an exceptional state and depending on the socket type, ØMQ shall take appropriate action such as blocking or dropping sent messages.

    This is a ZeroMQ 3.0 option

    value

  28. sealed trait SocketConnectOption extends SocketOption

    A base trait for connection options for a ZeroMQ socket

  29. sealed trait SocketMeta extends SocketOption

    Marker trait representing the base for all meta operations for a socket such as the context, listener, socket type and poller dispatcher

  30. sealed trait SocketOption extends Request

    Marker trait representing the base for all socket options

  31. sealed trait SocketOptionQuery extends Request

    A marker trait to group option queries together

  32. case class Subscribe(payload: ByteString) extends PubSubOption with Product with Serializable

    The akka.zeromq.Subscribe option establishes a new message filter on a akka.zeromq.SocketType.Pub socket.

    The akka.zeromq.Subscribe option establishes a new message filter on a akka.zeromq.SocketType.Pub socket. Newly created akka.zeromq.SocketType.Sub sockets filter out all incoming messages, therefore you should send this option to establish an initial message filter.

    An empty payload of length zero will subscribe to all incoming messages. A non-empty payload will subscribe to all messages beginning with the specified prefix. Multiple filters may be attached to a single akka.zeromq.SocketType.Sub socket, in which case a message will be accepted if it matches at least one filter.

    payload

    the topic to subscribe to

  33. case class Swap(value: Long) extends SocketOption with Product with Serializable

    The akka.zeromq.Swap option shall set the disk offload (swap) size for the specified socket.

    The akka.zeromq.Swap option shall set the disk offload (swap) size for the specified socket. A socket which has akka.zeromq.Swap set to a non-zero value may exceed its high water mark; in this case outstanding messages shall be offloaded to storage on disk rather than held in memory.

    The value of akka.zeromq.Swap defines the maximum size of the swap space in bytes.

    value

  34. case class Unsubscribe(payload: ByteString) extends PubSubOption with Product with Serializable

    The akka.zeromq.Unsubscribe option shall remove an existing message filter on a akka.zeromq.SocketType.Sub socket.

    The akka.zeromq.Unsubscribe option shall remove an existing message filter on a akka.zeromq.SocketType.Sub socket. The filter specified must match an existing filter previously established with the akka.zeromq.Subscribe option. If the socket has several instances of the same filter attached the akka.zeromq.Unsubscribe option shall remove only one instance, leaving the rest in place and functional.

    payload

  35. case class ZMQMessage(frames: Seq[ByteString]) extends Product with Serializable

    A message received over the zeromq socket

    A message received over the zeromq socket

    frames

  36. class ZMQMessageDeserializer extends Deserializer

    Deserializes ZeroMQ messages into an immutable sequence of frames

  37. class ZeroMQExtension extends Extension

    The extension for the ZeroMQ module

  38. case class ZeroMQVersion(major: Int, minor: Int, patch: Int) extends Product with Serializable

    A Model to represent a version of the zeromq library

    A Model to represent a version of the zeromq library

    major
    minor
    patch

Value Members

  1. object Affinity extends SocketOptionQuery with Serializable

    Gets the akka.zeromq.Affinity value

  2. object Backlog extends SocketOptionQuery with Serializable

    Gets the backlog

    Gets the backlog

    See also

    akka.zeromq.Backlog

  3. object Closed extends Response with Product with Serializable

    When the ZeroMQ socket disconnects it sends this message to a listener

  4. object Connecting extends Response with Product with Serializable

    When the ZeroMQ socket connects it sends this message to a listener

  5. object Context

    Companion object for a ZeroMQ I/O thread pool

  6. object FileDescriptor extends SocketOptionQuery

    Gets the file descriptor associated with the ZeroMQ socket

  7. object Identity extends SocketOptionQuery with Serializable

    Gets the akka.zeromq.Identity value

  8. object Linger extends SocketOptionQuery with Serializable

    Gets the linger option @see akka.zeromq.Linger

  9. object MaxMsgSize extends SocketOptionQuery with Serializable

  10. object MulticastHops extends SocketOptionQuery with Serializable

    Gets the akka.zeromq.MulticastHops

  11. object MulticastLoop extends SocketOptionQuery with Serializable

    Gets the akka.zeromq.MulticastLoop

  12. val NoLinger: Linger

    Set the linger to 0, doesn't block and discards messages that haven't been sent yet.

  13. object Rate extends SocketOptionQuery with Serializable

    Gets the send or receive rate for the socket

  14. object ReceiveBufferSize extends SocketOptionQuery with Serializable

    Gets the akka.zeromq.ReceiveBufferSize

  15. object ReceiveHighWatermark extends SocketOptionQuery with Serializable

    Gets the ReceiveHighWatermark

    Gets the ReceiveHighWatermark

    See also

    akka.zeromq.ReceiveHighWatermark

  16. object ReconnectIVL extends SocketOptionQuery with Serializable

    Gets the recover interval @see akka.zeromq.ReconnectIVL

  17. object ReconnectIVLMax extends SocketOptionQuery with Serializable

    Gets the max reconnect IVL

    Gets the max reconnect IVL

    See also

    akka.zeromq.ReconnectIVLMax

  18. object RecoveryInterval extends SocketOptionQuery with Serializable

    Gets the akka.zeromq.RecoveryInterval

  19. object SendBufferSize extends SocketOptionQuery with Serializable

    Gets the akka.zeromq.SendBufferSize

  20. object SendHighWatermark extends SocketOptionQuery with Serializable

    Gets the SendHWM

    Gets the SendHWM

    See also

    akka.zeromq.SendHighWatermark

  21. object SocketType

    The different socket types you can create with zeromq

  22. object Subscribe extends Serializable

  23. val SubscribeAll: Subscribe

    Convenience accessor to subscribe to all events

  24. object Swap extends SocketOptionQuery with Serializable

    Gets the akka.zeromq.Swap

  25. object Unsubscribe extends Serializable

  26. object ZMQMessage extends Serializable

  27. object ZeroMQ

    Java API for akka.zeromq

  28. object ZeroMQExtension extends ExtensionId[ZeroMQExtension] with ExtensionIdProvider

    The akka.actor.ExtensionId and akka.actor.ExtensionIdProvider for the ZeroMQ module

Inherited from AnyRef

Inherited from Any

Ungrouped