C# Class NetMQ.NetMQBeacon

Inheritance: IDisposable, ISocketPollable
Show file Open project: NetMQ/NetMQ3-x Class Usage Examples

Private Properties

Property Type Description
NetMQBeacon System
Receive byte[]
ReceiveString string

Public Methods

Method Description
Configure ( [ interfaceName, int port ) : void

Configure beacon to bind to specific interface
Configure ( int port ) : void

Configure beacon to bind to default interface
ConfigureAllInterfaces ( int port ) : void

Configure beacon to bind to all interfaces
Dispose ( ) : void

Release any contained resources.
NetMQBeacon ( ) : System

Create a new NetMQBeacon.
Publish ( [ transmit ) : void

Publish beacon immediately and continue to publish every second
Publish ( [ transmit, System.TimeSpan interval ) : void

Publish beacon immediately and continue to publish when interval elapsed
Silence ( ) : void

Stop publish messages
Subscribe ( [ filter ) : void

Subscribe to beacon messages, will replace last subscribe call
TryReceiveString ( System.TimeSpan timeout, string &peerName, string &message ) : bool

Attempt to receive a message from the specified peer for the specified amount of time.
Unsubscribe ( ) : void

Unsubscribe to beacon messages

Protected Methods

Method Description
Dispose ( bool disposing ) : void

Release any contained resources.

Private Methods

Method Description
NetMQBeacon ( [ context ) : System
Receive ( string &peerName ) : byte[]
ReceiveString ( string &peerName ) : string

Method Details

Configure() public method

Configure beacon to bind to specific interface
public Configure ( [ interfaceName, int port ) : void
interfaceName [ One of the ip address of the interface
port int Port to bind to
return void

Configure() public method

Configure beacon to bind to default interface
public Configure ( int port ) : void
port int Port to bind to
return void

ConfigureAllInterfaces() public method

Configure beacon to bind to all interfaces
public ConfigureAllInterfaces ( int port ) : void
port int Port to bind to
return void

Dispose() public method

Release any contained resources.
public Dispose ( ) : void
return void

Dispose() protected method

Release any contained resources.
protected Dispose ( bool disposing ) : void
disposing bool true if managed resources are to be released
return void

NetMQBeacon() public method

Create a new NetMQBeacon.
public NetMQBeacon ( ) : System
return System

Publish() public method

Publish beacon immediately and continue to publish every second
public Publish ( [ transmit ) : void
transmit [ Beacon to transmit
return void

Publish() public method

Publish beacon immediately and continue to publish when interval elapsed
public Publish ( [ transmit, System.TimeSpan interval ) : void
transmit [ Beacon to transmit
interval System.TimeSpan Interval to transmit beacon
return void

Silence() public method

Stop publish messages
public Silence ( ) : void
return void

Subscribe() public method

Subscribe to beacon messages, will replace last subscribe call
public Subscribe ( [ filter ) : void
filter [ Beacon will be filtered by this
return void

TryReceiveString() public method

Attempt to receive a message from the specified peer for the specified amount of time.
public TryReceiveString ( System.TimeSpan timeout, string &peerName, string &message ) : bool
timeout System.TimeSpan The maximum amount of time the call should wait for a message before returning.
peerName string the name of the peer that the message comes from is written to this string
message string the string to write the received message into
return bool

Unsubscribe() public method

Unsubscribe to beacon messages
public Unsubscribe ( ) : void
return void