jrtplib  3.8.2
Public Member Functions | List of all members
RTPIPv4Address Class Reference

Represents an IPv4 IP address and port. More...

#include <rtpipv4address.h>

Inheritance diagram for RTPIPv4Address:
Inheritance graph
[legend]
Collaboration diagram for RTPIPv4Address:
Collaboration graph
[legend]

Public Member Functions

 RTPIPv4Address (uint32_t ip=0, uint16_t port=0)
 Creates an instance with IP address ip and port number port (both are interpreted in host byte order). More...
 
 RTPIPv4Address (const uint8_t ip[4], uint16_t port=0)
 Creates an instance with IP address ip and port number port (port is interpreted in host byte order). More...
 
void SetIP (uint32_t ip)
 Sets the IP address for this instance to ip which is assumed to be in host byte order. More...
 
void SetIP (const uint8_t ip[4])
 Sets the IP address of this instance to ip. More...
 
void SetPort (uint16_t port)
 Sets the port number for this instance to port which is interpreted in host byte order. More...
 
uint32_t GetIP () const
 Returns the IP address contained in this instance in host byte order. More...
 
uint16_t GetPort () const
 Returns the port number of this instance in host byte order. More...
 
- Public Member Functions inherited from RTPAddress
AddressType GetAddressType () const
 Returns the type of address the actual implementation represents. More...
 

Additional Inherited Members

- Public Types inherited from RTPAddress
enum  AddressType { IPv4Address, IPv6Address, UserDefinedAddress }
 Identifies the actual implementation being used. More...
 

Detailed Description

This class is used by the UDP over IPv4 transmission component. When an RTPIPv4Address is used in one of the multicast functions of the transmitter, the port number is ignored. When an instance is used in one of the accept or ignore functions of the transmitter, a zero port number represents all ports for the specified IP address.

Constructor & Destructor Documentation

RTPIPv4Address::RTPIPv4Address ( uint32_t  ip = 0,
uint16_t  port = 0 
)
inline
RTPIPv4Address::RTPIPv4Address ( const uint8_t  ip[4],
uint16_t  port = 0 
)
inline

Member Function Documentation

uint32_t RTPIPv4Address::GetIP ( ) const
inline
uint16_t RTPIPv4Address::GetPort ( ) const
inline
void RTPIPv4Address::SetIP ( uint32_t  ip)
inline
void RTPIPv4Address::SetIP ( const uint8_t  ip[4])
inline
void RTPIPv4Address::SetPort ( uint16_t  port)
inline

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