osg::SocketAddress Class Reference
[Network]

Network address. More...

#include <OSGSocketAddress.h>

List of all members.

Public Types
typedef socketaddr	SocketAddrT
enum	Type { ANY, BROADCAST, MULTICAST }
Public Member Functions
Constructors
*	SocketAddress (const char *host, int port=0)
	SocketAddress (Type type=ANY, int port=0)
	SocketAddress (const SocketAddress &source)
Destructor
*virtual	~SocketAddress ()
Get/Set
*sockaddr *	getSockAddr (void) const
int	getSockAddrSize (void) const
void	setPort (int port)
void	setHost (const std::string &host)
int	getPort (void) const
std::string	getHost (void) const
std::string	getHostByName (void) const
Type querry
*bool	isMulticast (void)
Comparision
*bool	operator== (const SocketAddress &other) const
bool	operator!= (const SocketAddress &other) const
bool	operator< (const SocketAddress &other) const
Protected Attributes
static element
*struct sockaddr_in	_sockaddr

---

Detailed Description

The class SocketAddress holds an ip-address and a socket port number. It is used to connect, and sendTo Sockets.

Usage:

 SocketAddress a("colossus.world.com",3334);
 socket.bind(a);
 cout << a.getHost() << endl;
 cout << a.getPort() << endl;
 

Definition at line 58 of file OSGSocketAddress.h.

---

Member Typedef Documentation

typedef struct socketaddr osg::SocketAddress::SocketAddrT

Definition at line 71 of file OSGSocketAddress.h.

---

Member Enumeration Documentation

enum osg::SocketAddress::Type

Enumerator: ANY  BROADCAST  MULTICAST  Definition at line 64 of file OSGSocketAddress.h. { ANY,BROADCAST,MULTICAST };

---

Constructor & Destructor Documentation

SocketAddress::SocketAddress (  const char *  host, int  port = 0 )

type Definition at line 85 of file OSGSocketAddress.cpp. References _sockaddr, setHost(), and setPort(). { memset(&_sockaddr,0,sizeof(_sockaddr)); _sockaddr.sin_family = AF_INET; if(host) setHost(std::string(host)); setPort(port); }

osg::SocketAddress::SocketAddress (  Type  type = ANY, int  port = 0 )

type

SocketAddress::SocketAddress (  const SocketAddress &  source  )

copy Constructor Definition at line 115 of file OSGSocketAddress.cpp. References _sockaddr. { _sockaddr = source._sockaddr; }

SocketAddress::~SocketAddress (   )  [virtual]

Destructor Definition at line 122 of file OSGSocketAddress.cpp. { }

---

Member Function Documentation

sockaddr * SocketAddress::getSockAddr (  void   )  const

Get a pointer to the sockaddr struct Definition at line 206 of file OSGSocketAddress.cpp. References _sockaddr. Referenced by osg::StreamSocket::acceptFrom(), osg::Socket::bind(), osg::Socket::connect(), osg::Socket::getAddress(), getHostByName(), osg::DgramSocket::join(), osg::DgramSocket::leave(), osg::DgramSocket::peekFrom(), osg::DgramSocket::recvFrom(), osg::DgramSocket::sendTo(), and osg::DgramSocket::setMCastInterface(). { return const_cast<struct sockaddr *>( reinterpret_cast<const struct sockaddr *>(&_sockaddr)); }

int SocketAddress::getSockAddrSize (  void   )  const

Get the size of the sockaddr struct Definition at line 214 of file OSGSocketAddress.cpp. Referenced by osg::StreamSocket::acceptFrom(), osg::Socket::bind(), osg::Socket::connect(), osg::Socket::getAddress(), getHostByName(), osg::DgramSocket::peekFrom(), osg::DgramSocket::recvFrom(), osg::DgramSocket::sendTo(), and osg::DgramSocket::setMCastInterface(). { return sizeof(struct sockaddr_in); }

void SocketAddress::setPort (  int  port  )

Set the port number Definition at line 131 of file OSGSocketAddress.cpp. References _sockaddr, and osg::osghtons(). Referenced by osg::GroupMCastConnection::initialize(), and SocketAddress(). { _sockaddr.sin_port = osghtons( port ); }

void SocketAddress::setHost (  const std::string &  host  )

Set host name Definition at line 138 of file OSGSocketAddress.cpp. References _sockaddr. Referenced by osg::GroupMCastConnection::initialize(), and SocketAddress(). { struct hostent *hent; char const *c; // number or name ? for(c=host.c_str(); *c!='\0' && (isdigit(*c) || *c == '.'); c++); if(! *c ) { // inet_aton(const char *cp, struct in_addr *pin); // ip number was given _sockaddr.sin_addr.s_addr = inet_addr(host.c_str()); } else { // get address of host by name hent = gethostbyname(host.c_str()); if(hent == NULL) { throw SocketHostError("gethostbyname()"); } // set address _sockaddr.sin_addr = *(struct in_addr *) hent->h_addr; } }

int SocketAddress::getPort (  void   )  const

Get port number Definition at line 221 of file OSGSocketAddress.cpp. References _sockaddr, and osg::osgntohs(). Referenced by osg::PointSockConnection::bind(), osg::GroupSockConnection::bind(), osg::PointSockPipeline::initialize(), osg::PointMCastConnection::initialize(), osg::GroupMCastConnection::initialize(), and osg::GroupMCastConnection::sendQueue(). { return osgntohs(_sockaddr.sin_port); }

std::string SocketAddress::getHost (  void   )  const

Get host as number std::string Definition at line 169 of file OSGSocketAddress.cpp. References _sockaddr. Referenced by osg::PointSockConnection::bind(), osg::GroupSockConnection::bind(), osg::GroupMCastConnection::initialize(), and osg::GroupMCastConnection::sendQueue(). { return std::string(inet_ntoa(_sockaddr.sin_addr)); }

std::string SocketAddress::getHostByName (  void   )  const

Get host as name. If not found, return as number Definition at line 176 of file OSGSocketAddress.cpp. References _sockaddr, getSockAddr(), and getSockAddrSize(). { struct hostent *hent; std::string result; hent=gethostbyaddr((SocketAddrT*)getSockAddr(), getSockAddrSize(),AF_INET); if(hent == NULL) { // if no host assigned or host unknown // then return ip address result=inet_ntoa(_sockaddr.sin_addr); } else { result=hent->h_name; } return result; }

bool SocketAddress::isMulticast (  void   )

Returns true, if this is a multicast address Definition at line 198 of file OSGSocketAddress.cpp. References _sockaddr, and osg::osgntohl(). Referenced by osg::ClusterServer::acceptClient(). { UInt32 addr = osgntohl(_sockaddr.sin_addr.s_addr); return addr & 0xC0000; }

bool SocketAddress::operator== (  const SocketAddress &  other  )  const

compare equal Definition at line 231 of file OSGSocketAddress.cpp. References _sockaddr. { return _sockaddr.sin_addr.s_addr == other._sockaddr.sin_addr.s_addr && _sockaddr.sin_port == other._sockaddr.sin_port; }

bool SocketAddress::operator!= (  const SocketAddress &  other  )  const

compare not equal Definition at line 239 of file OSGSocketAddress.cpp. { return ! (*this == other); }

bool SocketAddress::operator< (  const SocketAddress &  other  )  const

compare less Definition at line 246 of file OSGSocketAddress.cpp. References _sockaddr. { return _sockaddr.sin_addr.s_addr < other._sockaddr.sin_addr.s_addr || ( _sockaddr.sin_addr.s_addr == other._sockaddr.sin_addr.s_addr && _sockaddr.sin_port < other._sockaddr.sin_port ); }

---

Member Data Documentation

* struct sockaddr_in osg::SocketAddress::_sockaddr [protected]

Definition at line 125 of file OSGSocketAddress.h. Referenced by getHost(), getHostByName(), getPort(), getSockAddr(), isMulticast(), operator<(), operator==(), setHost(), setPort(), and SocketAddress().

---

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

• OSGSocketAddress.h
• OSGSocketAddress.cpp

---