Package zmq

Class SocketBase

java.lang.Object
zmq.ZObject
zmq.Own
zmq.SocketBase
All Implemented Interfaces:
Pipe.IPipeEvents, IPollEvents
Direct Known Subclasses:
Channel, Client, Dealer, Dish, Gather, Pair, Pull, Push, Radio, Router, Scatter, Server, Stream, XPub, XSub
public abstract class SocketBase extends Own implements IPollEvents, Pipe.IPipeEvents

  • Field Details

    • connectRid

      protected String connectRid

  • Constructor Details

    • SocketBase

      protected SocketBase(Ctx parent, int tid, int sid)

    • SocketBase

      protected SocketBase(Ctx parent, int tid, int sid, boolean threadSafe)

  • Method Details

    • xattachPipe

      protected abstract void xattachPipe(Pipe pipe, boolean subscribe2all, boolean isLocallyInitiated)

    • xpipeTerminated

      protected abstract void xpipeTerminated(Pipe pipe)

    • destroy

      protected void destroy()
      Specified by:
      destroy in class Own

    • setSocketOpt

      public final boolean setSocketOpt(int option, Object optval)

    • getSocketOpt

      public final int getSocketOpt(int option)

    • getSocketOptx

      public final Object getSocketOptx(int option)

    • bind

      public final boolean bind(String addr)

    • connect

      public final boolean connect(String addr)

    • connectPeer

      public final int connectPeer(String addr)

    • disconnectPeer

      public boolean disconnectPeer(int routingId)

    • termEndpoint

      public final boolean termEndpoint(String addr)

    • send

      public final boolean send(Msg msg, int flags)

    • send

      public final boolean send(Msg msg, int flags, AtomicBoolean canceled)

    • recv

      public final Msg recv(int flags)

    • recv

      public final Msg recv(int flags, AtomicBoolean canceled)

    • join

      public final boolean join(String group)

    • leave

      public final boolean leave(String group)

    • cancel

      public final void cancel(AtomicBoolean canceled)

    • poll

      public final int poll(int interest, int timeout, AtomicBoolean canceled)

    • close

      public final void close()

    • processStop

      protected final void processStop()
      Overrides:
      processStop in class ZObject

    • processBind

      protected final void processBind(Pipe pipe)
      Overrides:
      processBind in class ZObject

    • processTerm

      protected final void processTerm(int linger)
      Overrides:
      processTerm in class Own

    • processDestroy

      protected final void processDestroy()
      Overrides:
      processDestroy in class Own

    • xsetsockopt

      protected boolean xsetsockopt(int option, Object optval)

    • xhasOut

      protected boolean xhasOut()

    • xsend

      protected boolean xsend(Msg msg)

    • xhasIn

      protected boolean xhasIn()

    • xrecv

      protected Msg xrecv()

    • getCredential

      protected Blob getCredential()

    • xreadActivated

      protected void xreadActivated(Pipe pipe)

    • xwriteActivated

      protected void xwriteActivated(Pipe pipe)

    • xhiccuped

      protected void xhiccuped(Pipe pipe)

    • xjoin

      protected boolean xjoin(String group)

    • xleave

      protected boolean xleave(String group)

    • xdisconnectPeer

      protected boolean xdisconnectPeer(int routingId)

    • inEvent

      public final void inEvent()
      Description copied from interface: IPollEvents
      Called by I/O thread when file descriptor is ready for reading.
      Specified by:
      inEvent in interface IPollEvents

    • readActivated

      public final void readActivated(Pipe pipe)
      Specified by:
      readActivated in interface Pipe.IPipeEvents

    • writeActivated

      public final void writeActivated(Pipe pipe)
      Specified by:
      writeActivated in interface Pipe.IPipeEvents

    • hiccuped

      public final void hiccuped(Pipe pipe)
      Specified by:
      hiccuped in interface Pipe.IPipeEvents

    • pipeTerminated

      public final void pipeTerminated(Pipe pipe)
      Specified by:
      pipeTerminated in interface Pipe.IPipeEvents

    • monitor

      public final boolean monitor(String addr, int events)
      Register the address for a monitor. It must be a inproc PAIR.
      Parameters:
      addr - or null for unregister.
      events - an event mask to monitor.
      Returns:
      true if creation succeeded.
      Throws:
      IllegalStateException - if a previous monitor was already registered and consumer is not null.

    • setEventHook

      public final boolean setEventHook(ZMQ.EventConsummer consumer, int events)
      Register a custom event consumer.
      Parameters:
      consumer - or null for unregister.
      events - an event mask to monitor.
      Returns:
      true if creation succeeded.
      Throws:
      IllegalStateException - if a previous monitor was already registered and consumer is not null.

    • eventHandshaken

      public final void eventHandshaken(String addr, int zmtpVersion)

    • eventConnected

      public final void eventConnected(String addr, SelectableChannel ch)

    • eventConnectDelayed

      public final void eventConnectDelayed(String addr, int errno)

    • eventConnectRetried

      public final void eventConnectRetried(String addr, int interval)

    • eventListening

      public final void eventListening(String addr, SelectableChannel ch)

    • eventBindFailed

      public final void eventBindFailed(String addr, int errno)

    • eventAccepted

      public final void eventAccepted(String addr, SelectableChannel ch)

    • eventAcceptFailed

      public final void eventAcceptFailed(String addr, int errno)

    • eventClosed

      public final void eventClosed(String addr, SelectableChannel ch)

    • eventCloseFailed

      public final void eventCloseFailed(String addr, int errno)

    • eventDisconnected

      public final void eventDisconnected(String addr, SelectableChannel ch)

    • eventHandshakeFailedNoDetail

      public final void eventHandshakeFailedNoDetail(String addr, int errno)

    • eventHandshakeFailedProtocol

      public final void eventHandshakeFailedProtocol(String addr, int errno)

    • eventHandshakeFailedAuth

      public final void eventHandshakeFailedAuth(String addr, int errno)

    • eventHandshakeSucceeded

      public final void eventHandshakeSucceeded(String addr, int errno)

    • monitorEvent

      protected final void monitorEvent(ZMQ.Event event)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getFD

      public final SelectableChannel getFD()

    • typeString

      public String typeString()

    • errno

      public final int errno()