C# Class NetMQ.NetMQPoller

Inheritance: System.Threading.Tasks.TaskScheduler, ISynchronizeInvoke, INetMQPoller, ISocketPollableCollection, IEnumerable, IDisposable
Show file Open project: NetMQ/NetMQ3-x Class Usage Examples

Private Properties

Property Type Description
CheckDisposed void
IEnumerable IEnumerator
ISynchronizeInvoke IAsyncResult
ISynchronizeInvoke object
ISynchronizeInvoke object
OnSocketEventsChanged void
RebuildPollset void
Run void
Run void

Public Methods

Method Description
Add ( ISocketPollable socket ) : void
Add ( [ timer ) : void
Add ( [ socket, [ callback ) : void
Dispose ( ) : void

Stops and disposes the poller. The poller may not be used once disposed.

NetMQPoller ( ) : System
Remove ( ISocketPollable socket ) : void
Remove ( [ timer ) : void
Run ( ) : void

Runs the poller on the caller's thread. Only returns when Stop or StopAsync are called from another thread.

RunAsync ( ) : void

Runs the poller in a background thread, returning immediately.

Stop ( ) : void

Stops the poller, blocking until stopped.

StopAsync ( ) : void

Stops the poller, returning immediately and most likely before the poller has actually stopped.

Protected Methods

Method Description
GetScheduledTasks ( ) : IEnumerable

Not supported.

QueueTask ( Task task ) : void
TryExecuteTaskInline ( Task task, bool taskWasPreviouslyQueued ) : bool

Private Methods

Method Description
CheckDisposed ( ) : void
IEnumerable ( ) : IEnumerator

This class only implements IEnumerable in order to support collection initialiser syntax.

ISynchronizeInvoke ( Delegate method, object args ) : IAsyncResult
ISynchronizeInvoke ( Delegate method, object args ) : object
ISynchronizeInvoke ( IAsyncResult result ) : object
OnSocketEventsChanged ( object sender, NetMQSocketEventArgs e ) : void
RebuildPollset ( ) : void
Run ( System.Action action ) : void
Run ( [ action ) : void

Method Details

Add() public method

public Add ( ISocketPollable socket ) : void
socket ISocketPollable
return void

Add() public method

public Add ( [ timer ) : void
timer [
return void

Add() public method

public Add ( [ socket, [ callback ) : void
socket [
callback [
return void

Dispose() public method

Stops and disposes the poller. The poller may not be used once disposed.
public Dispose ( ) : void
return void

GetScheduledTasks() protected method

Not supported.
Always thrown.
protected GetScheduledTasks ( ) : IEnumerable
return IEnumerable

NetMQPoller() public method

public NetMQPoller ( ) : System
return System

QueueTask() protected method

protected QueueTask ( Task task ) : void
task Task
return void

Remove() public method

public Remove ( ISocketPollable socket ) : void
socket ISocketPollable
return void

Remove() public method

public Remove ( [ timer ) : void
timer [
return void

Run() public method

Runs the poller on the caller's thread. Only returns when Stop or StopAsync are called from another thread.
public Run ( ) : void
return void

RunAsync() public method

Runs the poller in a background thread, returning immediately.
public RunAsync ( ) : void
return void

Stop() public method

Stops the poller, blocking until stopped.
public Stop ( ) : void
return void

StopAsync() public method

Stops the poller, returning immediately and most likely before the poller has actually stopped.
public StopAsync ( ) : void
return void

TryExecuteTaskInline() protected method

protected TryExecuteTaskInline ( Task task, bool taskWasPreviouslyQueued ) : bool
task Task
taskWasPreviouslyQueued bool
return bool