C# Class NetMQ.Core.Transports.StreamEngine

Inheritance: IEngine, IProactorEvents, IMsgSink
Datei anzeigen Open project: NetMQ/NetMQ3-x

Public Methods

Method Description
ActivateIn ( ) : void
ActivateOut ( ) : void
Destroy ( ) : void
InCompleted ( SocketError socketError, int bytesTransferred ) : void

This method is be called when a message receive operation has been completed.
OutCompleted ( SocketError socketError, int bytesTransferred ) : void

This method is called when a message Send operation has been completed.
Plug ( IOThread ioThread, SessionBase session ) : void
PushMsg ( Msg &msg ) : bool
StreamEngine ( AsyncIO.AsyncSocket handle, Options options, string endpoint ) : System
Terminate ( ) : void
TimerEvent ( int id ) : void

This would be called when a timer expires, although here it only throws NotSupportedException.

Private Methods

Method Description
Activate ( ) : void
BeginRead ( [ data, int size ) : void
BeginSending ( ) : void
BeginWrite ( [ data, int size ) : void
EndRead ( SocketError socketError, int bytesTransferred ) : int If socketError is SocketError.Success and bytesTransferred is > 0, then this returns bytesTransferred. If bytes is zero, or the socketError is one of NetworkDown, NetworkReset, HostUn, Connection Aborted, TimedOut, or ConnectionReset, - then -1 is returned. Otherwise, a NetMQException is thrown.
EndWrite ( SocketError socketError, int bytesTransferred ) : int If socketError is SocketError.Success and bytesTransferred is > 0, then this returns bytesTransferred. If bytes is zero, or the socketError is one of NetworkDown, NetworkReset, HostUn, Connection Aborted, TimedOut, or ConnectionReset, - then -1 is returned. Otherwise, a NetMQException is thrown.
EnqueueAction ( System.Action action, SocketError socketError, int bytesTransferred ) : void
Error ( ) : void
FeedAction ( System.Action action, SocketError socketError, int bytesTransferred ) : void
Handle ( System.Action action, SocketError socketError, int bytesTransferred ) : void
HandleHandshake ( System.Action action, SocketError socketError, int bytesTransferred ) : void
ProcessInput ( ) : void
Unplug ( ) : void

Method Details

ActivateIn() public method

public ActivateIn ( ) : void
return void

ActivateOut() public method

public ActivateOut ( ) : void
return void

Destroy() public method

public Destroy ( ) : void
return void

InCompleted() public method

This method is be called when a message receive operation has been completed.
public InCompleted ( SocketError socketError, int bytesTransferred ) : void
socketError SocketError a SocketError value that indicates whether Success or an error occurred
bytesTransferred int the number of bytes that were transferred
return void

OutCompleted() public method

This method is called when a message Send operation has been completed.
public OutCompleted ( SocketError socketError, int bytesTransferred ) : void
socketError SocketError a SocketError value that indicates whether Success or an error occurred
bytesTransferred int the number of bytes that were transferred
return void

Plug() public method

public Plug ( IOThread ioThread, SessionBase session ) : void
ioThread IOThread
session SessionBase
return void

PushMsg() public method

public PushMsg ( Msg &msg ) : bool
msg Msg
return bool

StreamEngine() public method

public StreamEngine ( AsyncIO.AsyncSocket handle, Options options, string endpoint ) : System
handle AsyncIO.AsyncSocket
options Options
endpoint string
return System

Terminate() public method

public Terminate ( ) : void
return void

TimerEvent() public method

This would be called when a timer expires, although here it only throws NotSupportedException.
TimerEvent is not supported on StreamEngine.
public TimerEvent ( int id ) : void
id int an integer used to identify the timer (not used here)
return void