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:

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...
void	Publish (string channel, byte[] data, int offset, int len)
	Publish() will be called when an application sends a message, and could be called on an arbitrary thread. More...
void	Subscribe (string channel)
	Subscribe() will be called when a channel subscription has been made. Providers that do not use a broadcast communications mechanism could use this notification to establish communications with additional hosts. More...
void	Unsubscribe (string channel)
	Unsubscribe() will be called when a channel subscription is cancelled. More...
void	Close ()
	Close() will be called when the application no longer requires the provider and wishes to free the resources used by the provider. For example, file handles and network sockets should be closed. After this method is called, the results of any calls to publish or subscribe are undefined. 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

TCPProvider()

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

inline

TCP provider constructor

Parameters

lcm	LCM object
up	URL parser object

Member Function Documentation

Close()

virtual void LCM.LCM.TCPProvider.Close ( )

inlinevirtual

Close the TCP provider

Implements LCM.LCM.Provider.

Publish()

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

channel	channel name
data	data byte array
offset	offset of the data to write
length	length of the data to write

Implements LCM.LCM.Provider.

Subscribe()

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

inlinevirtual

Subscribe method

Parameters

channel

channel name

Implements LCM.LCM.Provider.

Unsubscribe()

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

inline

Unsubscribe method

Parameters

channel

channel name

Implements LCM.LCM.Provider.

---

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

• lcm/lcm/TCPProvider.cs