Implemented By
Supported Methods
- GetBroadcast() as Boolean
- SetBroadcast(enable as Boolean) as Boolean
- JoinGroup(ipAddress as Object) as Boolean
- DropGroup(ipAddress as Object) as Boolean
- GetMulticastLoop() as Boolean
- SetMulticastLoop(enable as Boolean) as Boolean
- GetMulticastTTL() as Integer
- SetMulticastTTL(ttl as Integer) as Boolean
Description of Methods
Only the roDataGramSocket component supports the ifSocketCastOption multicast interface. The roStreamSocket component does not support multicast.
GetBroadcast() as Boolean
Return true if broadcast messages are enabled to be sent or received.
SetBroadcast(enable as Boolean) as Boolean
If enable is true, enable broadcast messages to be sent or received; otherwise do not send or receive broadcast messages.
Returns true if successfully set.
JoinGroup(ipAddress as Object) as Boolean
Join the multicast group specified by the passed in multicast ipAddress. ipAddress must be an roSocketAddress.
Ipv4 multicast addresses are in the range: 224.0.0.0 through 239.255.255.255
Returns true if successfully set.
DropGroup(ipAddress as Object) as Boolean
Drop out of the multicast group specified by the passed in multicast ipAddress. ipAddress must be an roSocketAddress.
Ipv4 multicast addresses are in the range: 224.0.0.0 through 239.255.255.255
Returns true if successfully set.
GetMulticastLoop() as Boolean
Return true if multicast messages are enabled for local loopback.
If enabled, multicast message sent locally are to be received locally.
SetMulticastLoop(enable as Boolean) as Boolean
If enable is true, enable local loopback of multicast messages; otherwise do not send or receive broadcast messages.
Returns true if successfully set.
GetMulticastTTL() as Integer
Return the TTL integer value for multicast messages.
TTL is the number of hops a packet is allowed before a router drops the packet.
SetMulticastTTL(ttl as Integer) as Boolean
Set the TTL integer value for multicast messages.
TTL is the number of hops a packet is allowed before a router drops the packet.
Returns true if successfully set.