#include <OsMulticastSocket.h>
Inheritance diagram for OsMulticastSocket:
Collaboration diagram for OsMulticastSocket:
Public Member Functions | |
| OsMulticastSocket (int multicastPort=PORT_DEFAULT, const char *multicastHostName=NULL, int localHostPort=PORT_DEFAULT, const char *localHostName=NULL) | |
| virtual | ~OsMulticastSocket () |
| int | joinGroup (const char *multicastHostName) |
| Joins a multicast group. Returns 0 on success. More... | |
| int | setHopCount (unsigned char hopCount) |
| Sets the hop count (a.k.a. TimeToLive) for outgoing multicast packets. More... | |
| int | setLoopback (bool enabled) |
| Enables/disables local loopback of outgoing multicast packets. More... | |
| virtual OsSocket::IpProtocolSocketType | getIpProtocol () const |
 Public Member Functions inherited from OsDatagramSocket | |
| OsDatagramSocket (int remoteHostPort, const char *remoteHostName, int localHostPort=PORT_DEFAULT, const char *localHostName=NULL) | |
| virtual | ~OsDatagramSocket () |
| virtual UtlBoolean | reconnect () |
| void | doConnect (int remotePort, const char *remoteHostName, UtlBoolean simulateConnect=FALSE) |
| virtual int | write (const char *buffer, int bufferLength) |
| param: remoteHostName - remote host to send datagram(s) in subsequent calls to write (overloaded version without host and port) param: remotePort - port on the remote host to send the datgram(s) param: simulateConnect - if TRUE do not call connect but default the to location (as in sendto) to the given host and port. This is desirable to prevent the receiving of packets from other hosts from being filtered out by the IP stack. More... | |
| virtual int | write (const char *buffer, int bufferLength, const char *ipAddress, int port) |
| param: buffer - the bytes to be written to the socket param: bufferLength - the number of bytes contained in buffer returns: the number of bytes actually written to the socket More... | |
| virtual int | read (char *buffer, int bufferLength) |
| param: buffer - the bytes to be written to the socket param: bufferLength - the number of bytes contained in buffer param: ipAddress - remote host to send datagram(s) to param: port - port on the remote host to send the datgram(s) returns: the number of bytes actually written to the socket More... | |
| virtual void | getRemoteHostIp (struct in_addr *remoteHostAddress, int *remotePort=NULL) |
| virtual UtlBoolean | getMappedIp (UtlString *ip, int *port) |
| Public Member Functions inherited from OsSocket | |
| virtual UtlContainableType | getContainableType () const |
| Determine whether or not the values in a containable are comparable. More... | |
| OsSocket () | |
| virtual | ~OsSocket () |
| virtual int | write (const char *buffer, int bufferLength, long waitMilliseconds) |
| param: buffer - The bytes to be written to the socket. param: bufferLength - The number of bytes contained in buffer. returns: The number of bytes actually written to the socket. returns: Note: This does not necessarily mean that the bytes were returns: actually received on the other end. More... | |
| virtual int | read (char *buffer, int bufferLength, UtlString *ipAddress, int *port) |
| param: buffer - Place to put bytes read from the socket. param: bufferLength - The maximum number of bytes buffer will hold. returns: The number of bytes actually read. More... | |
| virtual int | read (char *buffer, int bufferLength, struct in_addr *ipAddress, int *port) |
| param: buffer - Place to put bytes read from the socket. param: bufferLength - The maximum number of bytes buffer will hold. param: ipAddress - The address of the socket that sent the bytes read. param: port - The port of the socket that sent the bytes read. returns: The number of bytes actually read. More... | |
| virtual int | read (char *buffer, int bufferLength, long waitMilliseconds) |
| param: buffer - Place to put bytes read from the socket. param: bufferLength - The maximum number of bytes buffer will hold. param: ipAddress - The address of the socket that sent the bytes read. param: port - The port of the socket that sent the bytes read. returns: The number of bytes actually read. More... | |
| virtual void | close () |
| param: waitMilliseconds - The maximum number of milliseconds to block. This may be set to zero in which case it does not block. More... | |
| virtual void | makeNonblocking () |
| virtual void | makeBlocking () |
| virtual int | getSocketDescriptor () const |
| virtual void | getLocalHostIp (UtlString *localHostAddress) const |
| virtual const UtlString & | getLocalIp () const |
| virtual void | setLocalIp (const UtlString &localIp) |
| virtual int | getLocalHostPort () const |
| virtual void | getRemoteHostName (UtlString *remoteHostName) const |
| virtual void | getRemoteHostIp (UtlString *remoteHostAddress, int *remotePort=NULL) |
| virtual int | getRemoteHostPort () const |
| virtual UtlBoolean | isOk () const |
| virtual UtlBoolean | isConnected () const |
| virtual UtlBoolean | isReadyToReadEx (long waitMilliseconds, UtlBoolean &rSocketError) const |
| virtual UtlBoolean | isReadyToRead (long waitMilliseconds=0) const |
| virtual UtlBoolean | isReadyToWrite (long waitMilliseconds=0) const |
| Public Member Functions inherited from UtlContainableAtomic | |
| virtual unsigned | hash () const |
| Calculate a hash code for this object. More... | |
| virtual int | compareTo (UtlContainable const *) const |
| Compare this object to another object. More... | |
| Public Member Functions inherited from UtlContainable | |
| virtual | ~UtlContainable () |
| unsigned | directHash () const |
| Provides a hash function that uses the object pointer as the hash value. More... | |
| virtual UtlBoolean | isEqual (UtlContainable const *) const |
| Test this object to another object for equality. More... | |
| virtual UtlBoolean | isInstanceOf (const UtlContainableType type) const |
| Determine if this object is a derivative of the specified UtlContainableType. More... | |
Additional Inherited Members | |
| Public Types inherited from OsSocket | |
| enum | IpProtocolSocketType { UNKNOWN = -1, TCP = 0, UDP = 1, MULTICAST = 2, SSL_SOCKET = 3, CUSTOM = 4 } |
| Static Public Member Functions inherited from OsSocket | |
| static UtlBoolean | socketInit () |
| static unsigned long | initDefaultAdapterID (UtlString &adapter_id) |
| static void | setDefaultBindAddress (const unsigned long bind_address) |
| static const char * | ipProtocolString (OsSocket::IpProtocolSocketType) |
| return the string representation of the SocketProtocolType More... | |
| static void | getDomainName (UtlString &domain_name) |
| static unsigned long | getDefaultBindAddress () |
| static void | getHostName (UtlString *hostName) |
| static void | getHostIp (UtlString *hostAddress) |
| static UtlBoolean | isIp4Address (const char *address) |
| static UtlBoolean | isMcastAddr (const char *ipAddress) |
| static UtlBoolean | isLocalHost (const char *hostAddress) |
| static UtlBoolean | isSameHost (const char *host1, const char *host2) |
| static UtlBoolean | getHostIpByName (const char *hostName, UtlString *hostAddress) |
| static void | inet_ntoa_pt (struct in_addr input_address, UtlString &output_address) |
| static UtlBoolean | isFramed (IpProtocolSocketType type) |
| Static Public Member Functions inherited from UtlContainable | |
| static unsigned | stringHash (char const *value) |
| Provides a hash function appropriate for null-terminated string values. More... | |
| static UtlBoolean | areSameTypes (const UtlContainableType type1, const UtlContainableType type2) |
| Are UtlContainable types the same. More... | |
| Static Public Attributes inherited from OsSocket | |
| static UtlBoolean | socketInitialized = FALSE |
| Static Public Attributes inherited from UtlContainable | |
| static const UtlContainableType | TYPE = "UtlContainable" |
| Protected Member Functions inherited from OsDatagramSocket | |
| OsDatagramSocket () | |
| int | bind (int localHostPortNum=PORT_DEFAULT, const char *localHost=NULL) |
| Protected Attributes inherited from OsSocket | |
| OsAtomicLightInt | socketDescriptor |
| int | localHostPort |
| int | remoteHostPort |
| UtlString | mLocalIp |
| UtlString | localHostName |
| UtlString | remoteHostName |
| UtlString | mRemoteIpAddress |
| UtlBoolean | mIsConnected |
| Static Protected Attributes inherited from OsSocket | |
| static const UtlContainableType | TYPE = "OsSocket" |
| Class type used for runtime checking. More... | |
| static OsBSem | mInitializeSem |
Constructor & Destructor Documentation
| OsMulticastSocket | ( | int | multicastPort = PORT_DEFAULT, |
| const char * | multicastHostName = NULL, |
||
| int | localHostPort = PORT_DEFAULT, |
||
| const char * | localHostName = NULL |
||
| ) |
|
virtual |
Member Function Documentation
| int joinGroup | ( | const char * | multicastHostName | ) |
Joins a multicast group. Returns 0 on success.
| int setHopCount | ( | unsigned char | hopCount | ) |
Sets the hop count (a.k.a. TimeToLive) for outgoing multicast packets.
| int setLoopback | ( | bool | enabled | ) |
Enables/disables local loopback of outgoing multicast packets.
|
virtual |
Reimplemented from OsDatagramSocket.
