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

LCM provider for the udpm: URL. All messages are broadcast over a pre-arranged UDP multicast address. Subscription operations are a no-op, since all messages are always broadcast. More...

Inheritance diagram for LCM.LCM.UDPMulticastProvider:
LCM.LCM.Provider

Public Member Functions

 UDPMulticastProvider (LCM lcm, URLParser up)
 UDP multicast provider constructor More...
 
void Publish (string channel, byte[] data, int offset, int length)
 Publish a message More...
 
void Subscribe (string channel)
 Subscribe to a channel More...
 
void Unsubscribe (String channel)
 Unsubscribe from a channel More...
 
void Close ()
 Call to close the provider More...
 
- Public Member Functions inherited from LCM.LCM.Provider
void Unsubscribe (string channel)
 Unsubscribe() will be called when a channel subscription is cancelled. More...
 

Properties

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

Detailed Description

LCM provider for the udpm: URL. All messages are broadcast over a pre-arranged UDP multicast address. Subscription operations are a no-op, since all messages are always broadcast.

This mechanism is very simple, low-latency, and efficient due to not having to transmit messages more than once when there are multiple subscribers. Since it uses UDP, it is lossy.

Constructor & Destructor Documentation

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

UDP multicast provider constructor

Parameters
lcmLCM object
upURL parser object

Member Function Documentation

void LCM.LCM.UDPMulticastProvider.Close ( )
inline

Call to close the provider

Implements LCM.LCM.Provider.

void LCM.LCM.UDPMulticastProvider.Publish ( string  channel,
byte[]  data,
int  offset,
int  length 
)
inline

Publish a message

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

Implements LCM.LCM.Provider.

void LCM.LCM.UDPMulticastProvider.Subscribe ( string  channel)
inline

Subscribe to a channel

Parameters
channelchannel name

Implements LCM.LCM.Provider.

void LCM.LCM.UDPMulticastProvider.Unsubscribe ( String  channel)
inline

Unsubscribe from a channel

Parameters
channelchannel name

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