RWSockType Class Reference

A type of socket communications channel. More...

#include <rw/network/RWSockType.h>

Inheritance diagram for RWSockType:

Public Member Functions
	RWSockType ()
	RWSockType (const RWCString &familyName, int domain, int type=SOCK_STREAM, int protocol=0)
	~RWSockType ()
int	getDomain () const
int	getFamily () const
RWCString	getFamilyName () const
int	getProtocol () const
int	getType () const
RWCString	id (unsigned level) const

Related Symbols
(Note that these are not member symbols.)
bool	operator!= (const RWSockType &lhs, const RWSockType &rhs)
bool	operator== (const RWSockType &lhs, const RWSockType &rhs)

Detailed Description

RWSockType represents a type of socket communications channel. It is made up of a family (or domain), a type, and a protocol. An example of a family is the Internet TCP/IP family AF_INET. A socket type is SOCK_STREAM or SOCK_DGRAM. A protocol could be PF_INET or PF_UNSPEC.

Constructor & Destructor Documentation

RWSockType() [1/2]

RWSockType::RWSockType

(

)

Builds an invalid socket type. To set it to a valid type, use the assignment operator.

RWSockType() [2/2]

RWSockType::RWSockType	(	const RWCString &	familyName,
		int	domain,
		int	type = SOCK_STREAM,
		int	protocol = 0 )

Builds a socket communication type descriptor. The domain specifies the type of communications channel. For the Internet domain, it is AF_INET; for the Unix domain, it is AF_UNIX. type specifies the type of channel, usually SOCK_STREAM or SOCK_DGRAM. The RWCString should contain 7-bit US-ASCII data.

~RWSockType()

RWSockType::~RWSockType

(

)

Destructor.

Member Function Documentation

getDomain()

int RWSockType::getDomain ( ) const

inline

Alias for getFamily().

getFamily()

int RWSockType::getFamily ( ) const

inline

Returns the integer identifier of the address domain for the socket type, such as AF_INET for an Internet domain address.

getFamilyName()

RWCString RWSockType::getFamilyName ( ) const

inline

Returns a string representation of the address domain, such as "inet" for the Internet address domain. The RWCString should contain 7-bit US-ASCII data.

getProtocol()

int RWSockType::getProtocol ( ) const

inline

Gets the protocol family that describes the socket type.

getType()

int RWSockType::getType ( ) const

inline

Gets the socket type that describes the socket protocol.

id()

RWCString RWSockType::id

(

unsigned

level

)

const

Returns a string describing self. The parameter level is currently unused. This method will return a string representing the address family and socket type.

Given the example input:

RWSockType("inet", AF_INET, SOCK_DGRAM, IPPROTO_UDP);

the following output would be returned:

inet:dgram

Friends And Related Symbol Documentation

operator!=()

bool operator!= ( const RWSockType & lhs, const RWSockType & rhs )

related

Returns the negation of operator==(const RWSockType&, const RWSockType&).

operator==()

bool operator== ( const RWSockType & lhs, const RWSockType & rhs )

related

Returns true if all components (name, family, type, and protocol) in lhs and rhs are equivalent.