CAddressIPv4 Class Reference
[Addresses]

Inheritance diagram for CAddressIPv4:

Inheritance graph
[legend]
Collaboration diagram for CAddressIPv4:

Collaboration graph
[legend]

List of all members.


Detailed Description

An IPv4 address.


Public Types

typedef unsigned long Address
typedef unsigned short Port

Public Member Functions

 CAddressIPv4 ()
 Creates a CAddressIPv4 object that represents the IPv4 wilcard address, i.e. INADDR_ANY and port 0.
 CAddressIPv4 (const CAddress &address)
 Creates a CAddressIPv4 object which is a copy of the supplied address. Note that the address family for the supplied address must be AF_INET or an exception will be thrown. This constructor can be used to convert the correct type of 'generic Winsock Address' back into a full IPv4 address, so, for example, you could take the remote address of a socket connection and initiate a new outgoing connection to it because you have an instance of IFullAddress.
 CAddressIPv4 (const sockaddr_in &address)
 Creates a CAddressIPv4 object which is a copy of the supplied address.
 CAddressIPv4 (const Address address, const Port port)
 Creates a CAddressIPv4 object with the supplied address and port.
 CAddressIPv4 (const JetByteTools::Win32::_tstring &dottedIPorName, const Port port)
 Creates a CAddressIPv4 object from the supplied address in dotted ip format "xxx.xxx.xxx.xxx" and a port.
 CAddressIPv4 (const JetByteTools::Win32::_tstring &addressAsString)
 Creates a CAddressIPv4 object from the supplied address in the following string format: "xxx.xxx.xxx.xxx:port".
Address GetAddress () const
 Returns the address.
virtual Port GetPort () const
 Returns the port.
virtual const
IAddressType
Type () const
 Returns the address type for the address.
virtual IFullAddressClone () const
 Dynamically allocates a copy of this address. You are responsible for deallocating this copy with delete when you're done with it..
virtual short Family () const
 Returns the address family of the address.
virtual const sockaddr & AsSockAddr () const
 Returns the address as a reference to a sockaddr structure.
virtual int Size () const
 Returns the size of the sockaddr structure required to store the address.
virtual IAddressRefGetAddressRef () const
 Returns a reference counted view on this address, be sure to call Release() on the IAdressRef when you're done with it.


Member Typedef Documentation

typedef unsigned long Address

typedef unsigned short Port [inherited]


Constructor & Destructor Documentation

CAddressIPv4 (  ) 

Creates a CAddressIPv4 object that represents the IPv4 wilcard address, i.e. INADDR_ANY and port 0.

CAddressIPv4 ( const CAddress address  )  [explicit]

Creates a CAddressIPv4 object which is a copy of the supplied address. Note that the address family for the supplied address must be AF_INET or an exception will be thrown. This constructor can be used to convert the correct type of 'generic Winsock Address' back into a full IPv4 address, so, for example, you could take the remote address of a socket connection and initiate a new outgoing connection to it because you have an instance of IFullAddress.

CAddressIPv4 ( const sockaddr_in &  address  )  [explicit]

Creates a CAddressIPv4 object which is a copy of the supplied address.

CAddressIPv4 ( const Address  address,
const Port  port 
)

Creates a CAddressIPv4 object with the supplied address and port.

CAddressIPv4 ( const JetByteTools::Win32::_tstring dottedIPorName,
const Port  port 
)

Creates a CAddressIPv4 object from the supplied address in dotted ip format "xxx.xxx.xxx.xxx" and a port.

CAddressIPv4 ( const JetByteTools::Win32::_tstring addressAsString  ) 

Creates a CAddressIPv4 object from the supplied address in the following string format: "xxx.xxx.xxx.xxx:port".


Member Function Documentation

CAddressIPv4::Address GetAddress (  )  const

Returns the address.

IIPAddress::Port GetPort (  )  const [virtual]

Returns the port.

Implements IIPAddress.

const IAddressType & Type (  )  const [virtual]

Returns the address type for the address.

Implements IFullAddress.

IFullAddress * Clone (  )  const [virtual]

Dynamically allocates a copy of this address. You are responsible for deallocating this copy with delete when you're done with it..

Implements IFullAddress.

short Family (  )  const [virtual]

Returns the address family of the address.

Implements IAddress.

const sockaddr & AsSockAddr (  )  const [virtual]

Returns the address as a reference to a sockaddr structure.

Implements IAddress.

int Size (  )  const [virtual]

Returns the size of the sockaddr structure required to store the address.

Implements IAddress.

IAddressRef * GetAddressRef (  )  const [virtual]

Returns a reference counted view on this address, be sure to call Release() on the IAdressRef when you're done with it.

Implements IAddress.


Generated on Mon Sep 7 14:09:17 2009 for JetByte Socket Tools - v6.1 by  doxygen 1.5.3