LCM .NET API
Classes | Public Member Functions | Properties | List of all members
LCM.LCM.TCPProvider Class Reference

LCM provider for the tcp: URL. All messages are sent to a central "hub" process (that must be started separately), which will relay the messages to all other processes. TCPService is an implementation of the hub process. More...

Inheritance diagram for LCM.LCM.TCPProvider:
LCM.LCM.Provider

Public Member Functions

 TCPProvider (LCM lcm, URLParser up)
 TCP provider constructor More...
 
virtual void Publish (string channel, byte[] data, int offset, int length)
 Publish a message synchronously. However, if the server is not available, it will return immediately. More...
 
virtual void Subscribe (string channel)
 Subscribe method More...
 
void Unsubscribe (string channel)
 Unsubscribe method More...
 
virtual void Close ()
 Close the TCP provider More...
 

Properties

System.Net.IPAddress InetAddr [get]
 
int InetPort [get]
 

Detailed Description

LCM provider for the tcp: URL. All messages are sent to a central "hub" process (that must be started separately), which will relay the messages to all other processes. TCPService is an implementation of the hub process.

The tcpq:// protocol is NOT suitable for real-time or high-bandwidth traffic. It is specifically designed for playing back a log file in a post-processing context (i.e., play back the log as fast as possible, but without dropping anything).

The .NET implementation is functionally equal to the Java version.

Constructor & Destructor Documentation

LCM.LCM.TCPProvider.TCPProvider ( LCM  lcm,
URLParser  up 
)
inline

TCP provider constructor

Parameters
lcmLCM object
upURL parser object

Member Function Documentation

virtual void LCM.LCM.TCPProvider.Close ( )
inlinevirtual

Close the TCP provider

Implements LCM.LCM.Provider.

virtual void LCM.LCM.TCPProvider.Publish ( string  channel,
byte[]  data,
int  offset,
int  length 
)
inlinevirtual

Publish a message synchronously. However, if the server is not available, it will return immediately.

Parameters
channelchannel name
datadata byte array
offsetoffset of the data to write
lengthlength of the data to write

Implements LCM.LCM.Provider.

virtual void LCM.LCM.TCPProvider.Subscribe ( string  channel)
inlinevirtual

Subscribe method

Parameters
channelchannel name

Implements LCM.LCM.Provider.

void LCM.LCM.TCPProvider.Unsubscribe ( string  channel)
inline

Unsubscribe method

Parameters
channelchannel name

Implements LCM.LCM.Provider.


The documentation for this class was generated from the following file: