Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages   Examples  

UDPIPv4Socket Class Reference

Socket for RTP stack based on UDP and IPv4. More...

#include <rtp.h>

Inheritance diagram for UDPIPv4Socket:

UDPSocket List of all members.

Public Methods

 UDPIPv4Socket (const InetAddress &ia, tpport_t port)
 ~UDPIPv4Socket ()
sockerror_t Connect (const InetAddress &ia, tpport_t port)
bool isPendingPacket (microtimeout_t timeout)
size_t writePacket (const unsigned char *const buffer, size_t len)
size_t readPacket (unsigned char *buffer, size_t len)
sockerror_t setMulticast (bool enable)
sockerror_t joinGroup (const InetMcastAddress &ia)
sockerror_t leaveGroup (const InetMcastAddress &ia)
sockerror_t setMcastTTL (uint8 ttl)
void endSocket ()

Detailed Description

Socket for RTP stack based on UDP and IPv4.

Wrapper for UDPSocket that provides the physical I/O related methods needed by the data or control connection of an RTP stack, based on UDP and IPv4. It should be "straightforward" defining wrappers like this for other underlying protocols, and then instantiating the template T_RTPSocket for them.

Author(s):
Federico Montesino <p5087@quintero.fie.us.es>

Definition at line 2040 of file rtp.h.


Constructor & Destructor Documentation

UDPIPv4Socket::UDPIPv4Socket ( const InetAddress & ia,
tpport_t port ) [inline]
 

Constructor.

Parameters:
bind   network address this socket is to be bound
port   transport port this socket is to be bound

Definition at line 2049 of file rtp.h.

UDPIPv4Socket::~UDPIPv4Socket ( ) [inline]
 

Destructor.

Definition at line 2056 of file rtp.h.


Member Function Documentation

sockerror_t UDPIPv4Socket::Connect ( const InetAddress & ia,
tpport_t port )
 

Connect to a foreign socket.

Parameters:
ia   network address to connect to
port   transport port to connect to

void UDPIPv4Socket::endSocket ( ) [inline]
 

End socket, terminating the socket connection.

Definition at line 2130 of file rtp.h.

bool UDPIPv4Socket::isPendingPacket ( microtimeout_t timeout ) [inline]
 

Definition at line 2072 of file rtp.h.

sockerror_t UDPIPv4Socket::joinGroup ( const InetMcastAddress & ia ) [inline]
 

Join a multicast group.

Parameters:
ia   multicast group address
Returns:
error code from the socket operation

Definition at line 2103 of file rtp.h.

sockerror_t UDPIPv4Socket::leaveGroup ( const InetMcastAddress & ia ) [inline]
 

Leave a multicast group.

Parameters:
ia   multicast group address
Returns:
error code from the socket operation

Definition at line 2113 of file rtp.h.

size_t UDPIPv4Socket::readPacket ( unsigned char * buffer,
size_t len ) [inline]
 

Definition at line 2086 of file rtp.h.

sockerror_t UDPIPv4Socket::setMcastTTL ( uint8 ttl ) [inline]
 

Set the value of the TTL field in the packets to send.

Parameters:
ttl   Time To Live
Returns:
error code from the socket operation

Definition at line 2123 of file rtp.h.

sockerror_t UDPIPv4Socket::setMulticast ( bool enable ) [inline]
 

Definition at line 2093 of file rtp.h.

size_t UDPIPv4Socket::writePacket ( const unsigned char *const buffer,
size_t len ) [inline]
 

Definition at line 2079 of file rtp.h.


The documentation for this class was generated from the following file:
Generated at Fri Oct 5 10:28:27 2001 for ccRTP by doxygen1.2.5 written by Dimitri van Heesch, © 1997-2001