C# Class NetMQ.Core.Patterns.Router

A Router is a subclass of SocketBase
Inheritance: SocketBase
Show file Open project: NetMQ/NetMQ3-x

Public Methods

Method Description
Destroy ( ) : void
Router ( [ parent, int threadId, int socketId ) : System

Create a new Router instance with the given parent-Ctx, thread-id, and socket-id.

Protected Methods

Method Description
Rollback ( ) : void
XAttachPipe ( Pipe pipe, bool icanhasall ) : void

Register the pipe with this socket.

XHasIn ( ) : bool
XHasOut ( ) : bool
XReadActivated ( Pipe pipe ) : void

Indicate the given pipe as being ready for reading by this socket.

XRecv ( Msg &msg ) : bool

Receive a message. The Recv method calls this lower-level method to do the actual receiving.

XSend ( Msg &msg ) : bool

Transmit the given message. The Send method calls this to do the actual sending.

XSetSocketOption ( ZmqSocketOption option, object optval ) : bool
XTerminated ( Pipe pipe ) : void

This is an override of the abstract method that gets called to signal that the given pipe is to be removed from this socket.

XWriteActivated ( Pipe pipe ) : void

Indicate the given pipe as being ready for writing to by this socket. This gets called by the WriteActivated method.

Private Methods

Method Description
IdentifyPeer ( [ pipe ) : bool

Method Details

Destroy() public method

public Destroy ( ) : void
return void

Rollback() protected method

protected Rollback ( ) : void
return void

Router() public method

Create a new Router instance with the given parent-Ctx, thread-id, and socket-id.
public Router ( [ parent, int threadId, int socketId ) : System
parent [ the Ctx that will contain this Router
threadId int the integer thread-id value
socketId int the integer socket-id value
return System

XAttachPipe() protected method

Register the pipe with this socket.
protected XAttachPipe ( Pipe pipe, bool icanhasall ) : void
pipe Pipe the Pipe to attach
icanhasall bool not used
return void

XHasIn() protected method

protected XHasIn ( ) : bool
return bool

XHasOut() protected method

protected XHasOut ( ) : bool
return bool

XReadActivated() protected method

Indicate the given pipe as being ready for reading by this socket.
protected XReadActivated ( Pipe pipe ) : void
pipe Pipe the Pipe that is now becoming available for reading
return void

XRecv() protected method

Receive a message. The Recv method calls this lower-level method to do the actual receiving.
protected XRecv ( Msg &msg ) : bool
msg Msg the Msg to receive the message into
return bool

XSend() protected method

Transmit the given message. The Send method calls this to do the actual sending.
The receiving host must be identifiable.
protected XSend ( Msg &msg ) : bool
msg Msg the message to transmit
return bool

XSetSocketOption() protected method

protected XSetSocketOption ( ZmqSocketOption option, object optval ) : bool
option ZmqSocketOption
optval object
return bool

XTerminated() protected method

This is an override of the abstract method that gets called to signal that the given pipe is to be removed from this socket.
protected XTerminated ( Pipe pipe ) : void
pipe Pipe the Pipe that is being removed
return void

XWriteActivated() protected method

Indicate the given pipe as being ready for writing to by this socket. This gets called by the WriteActivated method.
protected XWriteActivated ( Pipe pipe ) : void
pipe Pipe the Pipe that is now becoming available for writing
return void