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
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static class
private static class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
protected String
private AtomicBoolean
private AtomicBoolean
private final MultiMap
<String, SocketBase.EndpointPipe> private SocketChannel
private Poller.Handle
private ThreadLocal
<Boolean> private long
private final IMailbox
private int
private SocketBase
private final ReentrantLock
private Poller
private boolean
private Signaler
private final boolean
private final ReentrantLock
private int
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
SocketBase
(Ctx parent, int tid, int sid) protected
SocketBase
(Ctx parent, int tid, int sid, boolean threadSafe) -
Method Summary
Modifier and TypeMethodDescriptionprivate void
addEndpoint
(String addr, Own endpoint, Pipe pipe) private void
attachPipe
(Pipe pipe, boolean isLocallyInitiated) private void
attachPipe
(Pipe pipe, boolean subscribe2all, boolean isLocallyInitiated) final boolean
final void
cancel
(AtomicBoolean canceled) private void
private NetProtocol
checkProtocol
(String protocol) final void
close()
final boolean
private boolean
connectInternal
(String addr) final int
connectPeer
(String addr) protected void
destroy()
boolean
disconnectPeer
(int routingId) private void
final int
errno()
private void
final void
eventAccepted
(String addr, SelectableChannel ch) final void
eventAcceptFailed
(String addr, int errno) final void
eventBindFailed
(String addr, int errno) final void
eventClosed
(String addr, SelectableChannel ch) final void
eventCloseFailed
(String addr, int errno) final void
eventConnectDelayed
(String addr, int errno) final void
eventConnected
(String addr, SelectableChannel ch) final void
eventConnectRetried
(String addr, int interval) final void
eventDisconnected
(String addr, SelectableChannel ch) final void
eventHandshakeFailedAuth
(String addr, int errno) final void
eventHandshakeFailedNoDetail
(String addr, int errno) final void
eventHandshakeFailedProtocol
(String addr, int errno) final void
eventHandshaken
(String addr, int zmtpVersion) final void
eventHandshakeSucceeded
(String addr, int errno) final void
eventListening
(String addr, SelectableChannel ch) private void
extractFlags
(Msg msg) protected Blob
final SelectableChannel
getFD()
(package private) final IMailbox
final int
getSocketOpt
(int option) final Object
getSocketOptx
(int option) (package private) final boolean
hasIn()
(package private) final boolean
hasOut()
final void
final void
inEvent()
Called by I/O thread when file descriptor is ready for reading.(package private) boolean
isActive()
private boolean
final boolean
final boolean
private void
private void
lock()
final boolean
Register the address for a monitor.protected final void
monitorEvent
(ZMQ.Event event) final void
pipeTerminated
(Pipe pipe) final int
poll
(int interest, int timeout, AtomicBoolean canceled) protected final void
processBind
(Pipe pipe) private boolean
processCommands
(int timeout, boolean throttle, AtomicBoolean canceled) protected final void
protected final void
protected final void
processTerm
(int linger) final void
readActivated
(Pipe pipe) final Msg
recv
(int flags) final Msg
recv
(int flags, AtomicBoolean canceled) final boolean
final boolean
send
(Msg msg, int flags, AtomicBoolean canceled) final boolean
setSocketOpt
(int option, Object optval) (package private) final void
startReaping
(Poller poller) (package private) final void
stop()
private void
final boolean
termEndpoint
(String addr) toString()
private void
unlock()
final void
writeActivated
(Pipe pipe) protected abstract void
xattachPipe
(Pipe pipe, boolean subscribe2all, boolean isLocallyInitiated) protected boolean
xdisconnectPeer
(int routingId) protected boolean
xhasIn()
protected boolean
xhasOut()
protected void
protected boolean
protected boolean
protected abstract void
xpipeTerminated
(Pipe pipe) protected void
xreadActivated
(Pipe pipe) protected Msg
xrecv()
protected boolean
protected boolean
xsetsockopt
(int option, Object optval) protected void
xwriteActivated
(Pipe pipe) Methods inherited from class zmq.Own
incSeqnum, isTerminating, launchChild, processOwn, processSeqnum, processTermAck, processTermReq, registerTermAcks, termChild, terminate, unregisterTermAck
Methods inherited from class zmq.ZObject
chooseIoThread, connectPending, destroySocket, findEndpoint, getCtx, getTid, pendConnection, processActivateRead, processActivateWrite, processAttach, processCancel, processCommand, processHiccup, processPipeTerm, processPipeTermAck, processPlug, processReap, processReapAck, processReaped, registerEndpoint, sendActivateRead, sendActivateWrite, sendAttach, sendAttach, sendBind, sendBind, sendCancel, sendDone, sendHiccup, sendInprocConnected, sendOwn, sendPipeTerm, sendPipeTermAck, sendPlug, sendPlug, sendReap, sendReapAck, sendReaped, sendStop, sendTerm, sendTermAck, sendTermReq, setTid, unregisterEndpoint, unregisterEndpoints
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface zmq.poll.IPollEvents
acceptEvent, connectEvent, outEvent, timerEvent
-
Field Details
-
endpoints
-
inprocs
-
active
private boolean active -
ctxTerminated
-
isInEventThreadLocal
-
destroyed
-
mailbox
-
pipes
-
poller
-
handle
-
lastTsc
private long lastTsc -
ticks
private int ticks -
rcvmore
private boolean rcvmore -
fileDesc
-
monitorSocket
-
monitorEvents
private int monitorEvents -
connectRid
-
monitorSync
-
threadSafe
private final boolean threadSafe -
threadSafeSync
-
reaperSignaler
-
-
Constructor Details
-
SocketBase
-
SocketBase
-
-
Method Details
-
xattachPipe
-
xpipeTerminated
-
isActive
boolean isActive()- Returns:
- false if object is not a socket.
-
destroy
protected void destroy() -
getMailbox
-
stop
final void stop() -
checkProtocol
-
attachPipe
-
attachPipe
-
setSocketOpt
-
getSocketOpt
public final int getSocketOpt(int option) -
getSocketOptx
-
bind
-
connect
-
connectPeer
-
connectInternal
-
disconnectPeer
public boolean disconnectPeer(int routingId) -
addEndpoint
-
termEndpoint
-
send
-
send
-
recv
-
recv
-
join
-
leave
-
cancel
-
poll
-
close
public final void close() -
hasIn
final boolean hasIn() -
hasOut
final boolean hasOut() -
startReaping
-
isInEvent
private boolean isInEvent() -
processCommands
-
processStop
protected final void processStop()- Overrides:
processStop
in classZObject
-
processBind
- Overrides:
processBind
in classZObject
-
processTerm
protected final void processTerm(int linger) - Overrides:
processTerm
in classOwn
-
processDestroy
protected final void processDestroy()- Overrides:
processDestroy
in classOwn
-
xsetsockopt
-
xhasOut
protected boolean xhasOut() -
xsend
-
xhasIn
protected boolean xhasIn() -
xrecv
-
getCredential
-
xreadActivated
-
xwriteActivated
-
xhiccuped
-
xjoin
-
xleave
-
xdisconnectPeer
protected boolean xdisconnectPeer(int routingId) -
enterInEvent
private void enterInEvent() -
leaveInEvent
private void leaveInEvent() -
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 interfaceIPollEvents
-
checkDestroy
private void checkDestroy() -
readActivated
- Specified by:
readActivated
in interfacePipe.IPipeEvents
-
writeActivated
- Specified by:
writeActivated
in interfacePipe.IPipeEvents
-
hiccuped
- Specified by:
hiccuped
in interfacePipe.IPipeEvents
-
pipeTerminated
- Specified by:
pipeTerminated
in interfacePipe.IPipeEvents
-
extractFlags
-
monitor
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.
-
eventHandshaken
-
eventConnected
-
eventConnectDelayed
-
eventConnectRetried
-
eventListening
-
eventBindFailed
-
eventAccepted
-
eventAcceptFailed
-
eventClosed
-
eventCloseFailed
-
eventDisconnected
-
eventHandshakeFailedNoDetail
-
eventHandshakeFailedProtocol
-
eventHandshakeFailedAuth
-
eventHandshakeSucceeded
-
event
-
monitorEvent
-
stopMonitor
private void stopMonitor() -
toString
-
getFD
-
typeString
-
errno
public final int errno() -
lock
private void lock() -
unlock
private void unlock()
-