IP*Works! MultiCast Component : MultiCast OCX, MultiCast .NET Component, MultiCast Class, MultiCast Bean, MultiCast Object

Available in: IP*WORKS!

Mcast Class

MCast Component [IP*Works! V8]

Properties Methods Events Configuration Settings

The MCast component is used to multicast UDP datagrams to multicast capable hosts in multicast capable subnets. It can act both as a client and a server and communicate with any number of hosts simultaneously, as well as generate and receive broadcast packets.

NOTE: What follows is a very short description of the component interfaces. For more information, please consult the help files that come with the respective package.

Remarks

The MCast component is very similar to UDPPort, except for some additional properties that provide support for multicast datagrams. To send datagrams to a multicast group, simply assign the address of the group to RemoteHost. To receive datagrams from one or more groups, assign the group addresses to MulticastGroup one by one (after the component is activated. TimeToLive allows to specify how many subnets a packet should be allowed to receive. ReceiveInterface and SendInterface allow you to select the network interface for multicast operations.

The component is activated/deactivated through the Active property. This property enables or disables sends or receives. The data can be sent in the same way as UDPPort, by calling the Send method with a Text parameter or via the DataToSend property. The destination is specified using the RemoteHost and RemotePort properties. Inbound data is received through the DataIn event.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for complete descriptions.


AcceptData	Enables or disables data reception (the DataIn event).
Active	Enables or disables sending and receiving of data.
DataToSend	A string of data to be sent to the remote host. Write-only property.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
LocalPort	The UDP port in the local host where MCast binds.
Loopback	Enables or disables loopback of data sent to the multicast group.
MulticastGroup	Multicast group to join or leave.
ReceiveInterface	The interface to receive multicast packets with. If empty, default is used.
RemoteHost	The address of the remote host (multicast group).
RemotePort	The UDP port in the remote host.
SendInterface	The interface to send multicast packets from. If empty, default is used.
TimeToLive	The maximum number of subnets that a multicast datagram can traverse.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for complete descriptions.


Config	Sets or retrieves a component configuration setting.
DoEvents	Processes events from the internal message queue.
Send	Send data to the remote host.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for complete descriptions.


DataIn	Fired when data is received.
Error	Information about errors during data delivery.
ReadyToSend	Fired when the component is ready to send data.

Configuration Settings

The following is a list of configuration settings for the component with short descriptions. Click on the links for complete descriptions.


AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
CodePage	The system code page used for Unicode to Multibyte translations (Windows/COM only).
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
MaxPacketSize	The maximum length of the packets that can be received.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
QOSFlags	Flags determining Quality Of Service bits of packets sent by the socket.
ShareLocalPort	If set to True, allows more than one instance of the component to be active on the same local port.
SocketHandle	The handle of the main socket used by the component.
UseConnection	Determines whether to use a connected socket.
WinsockInfo	Identifying information about the loaded Winsock stack (Windows only)
WinsockLoaded	Loads and unloads Winsock on demand (Windows only)
WinsockMaxDatagramSize	Size in bytes of the largest UDP datagram that can be sent or received (Windows only)
WinsockMaxSockets	Maximum number of sockets available to a single process (Windows only)
WinsockPath	The path to the Winsock DLL used (Windows only)
WinsockStatus	The status of the Winsock stack (Windows only)