PIPSocket Class Reference

#include <ipsock.h>

Inheritance diagram for PIPSocket:

List of all members.

Public Member Functions
virtual PString	GetName () const
virtual PBoolean	OpenSocket (int ipAdressFamily=PF_INET)=0
virtual PBoolean	Connect (const PString &address)
virtual PBoolean	Connect (const Address &addr)
virtual PBoolean	Connect (WORD localPort, const Address &addr)
virtual PBoolean	Connect (const Address &iface, const Address &addr)
virtual PBoolean	Connect (const Address &iface, WORD localPort, const Address &addr)
virtual PBoolean	Listen (unsigned queueSize=5, WORD port=0, Reusability reuse=AddressIsExclusive)
virtual PBoolean	Listen (const Address &bind, unsigned queueSize=5, WORD port=0, Reusability reuse=AddressIsExclusive)
virtual PString	GetLocalAddress ()
virtual PBoolean	GetLocalAddress (Address &addr)
virtual PBoolean	GetLocalAddress (Address &addr, WORD &port)
virtual PString	GetPeerAddress ()
virtual PBoolean	GetPeerAddress (Address &addr)
virtual PBoolean	GetPeerAddress (Address &addr, WORD &port)
PString	GetLocalHostName ()
PString	GetPeerHostName ()
	PARRAY (RouteTable, RouteEntry)
	PARRAY (InterfaceTable, InterfaceEntry)
PBoolean	SetCaptureReceiveToAddress ()
PIPSocket::Address	GetLastReceiveToAddress () const
Static Public Member Functions
static int	GetDefaultIpAddressFamily ()
static void	SetDefaultIpAddressFamily (int ipAdressFamily)
static void	SetDefaultIpAddressFamilyV4 ()
static PIPSocket::Address	GetDefaultIpAny ()
static PString	GetHostName ()
static PString	GetHostName (const PString &hostname)
static PString	GetHostName (const Address &addr)
static PBoolean	GetHostAddress (Address &addr)
static PBoolean	GetHostAddress (const PString &hostname, Address &addr)
static PStringArray	GetHostAliases (const PString &hostname)
static PStringArray	GetHostAliases (const Address &addr)
static PBoolean	IsLocalHost (const PString &hostname)
static void	ClearNameCache ()
static PBoolean	GetGatewayAddress (Address &addr)
static PString	GetGatewayInterface ()
static PIPSocket::Address	GetRouteInterfaceAddress (PIPSocket::Address remoteAddress)
static PBoolean	GetRouteTable (RouteTable &table)
static bool	WaitForRouteTableChange (const PTimeInterval &timeout, PSyncPoint *cancellation=NULL)
static PBoolean	GetInterfaceTable (InterfaceTable &table, PBoolean includeDown=PFalse)
static PBoolean	GetNetworkInterface (PIPSocket::Address &addr)
Protected Member Functions
	PIPSocket ()
Classes
class	Address
class	InterfaceEntry
class	RouteEntry

---

Detailed Description

This class describes a type of socket that will communicate using the Internet Protocol. If P_HAS_IPV6 is not set, IPv4 only is supported. If P_HAS_IPV6 is set, both IPv4 and IPv6 adresses are supported, with IPv4 as default. This allows to transparently use IPv4, IPv6 or Dual stack operating systems.

---

Constructor & Destructor Documentation

PIPSocket::PIPSocket

(

)

[protected]

---

Member Function Documentation

virtual PString PIPSocket::GetName

(

)

const [virtual]

Get the platform and I/O channel type name of the channel. For an IP socket this returns the host name of the peer the socket is connected to, followed by the socket number it is connected to.

Returns:

the name of the channel.

Reimplemented from PChannel.

static int PIPSocket::GetDefaultIpAddressFamily

(

)

[static]

static void PIPSocket::SetDefaultIpAddressFamily

(

int

ipAdressFamily

)

[static]

static void PIPSocket::SetDefaultIpAddressFamilyV4

(

)

[static]

static PIPSocket::Address PIPSocket::GetDefaultIpAny

(

)

[static]

virtual PBoolean PIPSocket::OpenSocket

(

int

ipAdressFamily = PF_INET

)

[pure virtual]

Implemented in PICMPSocket, PTCPSocket, and PUDPSocket.

virtual PBoolean PIPSocket::Connect

(

const PString &

address

)

[virtual]

Connect a socket to a remote host on the specified port number. This is typically used by the client or initiator of a communications channel. This connects to a "listening" socket at the other end of the communications channel.

The port number as defined by the object instance construction or the PIPSocket::SetPort()# function.

Returns:

PTrue if the channel was successfully connected to the remote host.

Parameters:

address

Address of remote machine to connect to.

Reimplemented from PSocket.

Reimplemented in PUDPSocket, PSocksSocket, PSocksUDPSocket, and PTelnetSocket.

virtual PBoolean PIPSocket::Connect

(

const Address &

addr

)

[virtual]

Parameters:

addr	Address of remote machine to connect to.

virtual PBoolean PIPSocket::Connect	(	WORD	localPort,
		const Address &	addr
	)			[virtual]

Parameters:

localPort	Local port number for connection
addr	Address of remote machine to connect to.

virtual PBoolean PIPSocket::Connect	(	const Address &	iface,
		const Address &	addr
	)			[virtual]

Parameters:

iface	Address of local interface to us.
addr	Address of remote machine to connect to.

virtual PBoolean PIPSocket::Connect	(	const Address &	iface,
		WORD	localPort,
		const Address &	addr
	)			[virtual]

Parameters:

iface	Address of local interface to us.
localPort	Local port number for connection
addr	Address of remote machine to connect to.

virtual PBoolean PIPSocket::Listen	(	unsigned	queueSize = 5,
		WORD	port = 0,
		Reusability	reuse = AddressIsExclusive
	)			[virtual]

Listen on a socket for a remote host on the specified port number. This may be used for server based applications. A "connecting" socket begins a connection by initiating a connection to this socket. An active socket of this type is then used to generate other "accepting" sockets which establish a two way communications channel with the "connecting" socket.

If the port# parameter is zero then the port number as defined by the object instance construction or the PIPSocket::SetPort()# function.

For the UDP protocol, the queueSize# parameter is ignored.

Returns:

PTrue if the channel was successfully opened.

Parameters:

queueSize	Number of pending accepts that may be queued.
port	Port number to use for the connection.
reuse	Can/Cant listen more than once.

Reimplemented from PSocket.

Reimplemented in PTCPSocket, PSocksSocket, and PSocksUDPSocket.

virtual PBoolean PIPSocket::Listen	(	const Address &	bind,
		unsigned	queueSize = 5,
		WORD	port = 0,
		Reusability	reuse = AddressIsExclusive
	)			[virtual]

Parameters:

bind	Local interface address to bind to.
queueSize	Number of pending accepts that may be queued.
port	Port number to use for the connection.
reuse	Can/Can't listen more than once.

static PString PIPSocket::GetHostName

(

)

[static]

Get the "official" host name for the host specified or if none, the host this process is running on. The host may be specified as an IP number or a hostname alias and is resolved to the canonical form.

Returns:

Name of the host or IP number of host.

static PString PIPSocket::GetHostName

(

const PString &

hostname

)

[static]

Parameters:

hostname

Hosts IP address to get name for

static PString PIPSocket::GetHostName

(

const Address &

addr

)

[static]

Parameters:

addr	Hosts IP address to get name for

static PBoolean PIPSocket::GetHostAddress

(

Address &

addr

)

[static]

Get the Internet Protocol address for the specified host, or if none specified, for the host this process is running on.

Returns:

PTrue if the IP number was returned.

Parameters:

addr	Variable to receive hosts IP address

static PBoolean PIPSocket::GetHostAddress	(	const PString &	hostname,
		Address &	addr
	)			[static]

Parameters:

addr	Variable to receive hosts IP address

static PStringArray PIPSocket::GetHostAliases

(

const PString &

hostname

)

[static]

Get the alias host names for the specified host. This includes all DNS names, CNAMEs, names in the local hosts file and IP numbers (as "dot" format strings) for the host.

Returns:

array of strings for each alias for the host.

static PStringArray PIPSocket::GetHostAliases

(

const Address &

addr

)

[static]

Parameters:

addr	Hosts IP address

static PBoolean PIPSocket::IsLocalHost

(

const PString &

hostname

)

[static]

Determine if the specified host is actually the local machine. This can be any of the host aliases or multi-homed IP numbers or even the special number 127.0.0.1 for the loopback device.

Returns:

PTrue if the host is the local machine.

virtual PString PIPSocket::GetLocalAddress

(

)

[virtual]

Get the Internet Protocol address and port for the local host.

Returns:

PFalse (or empty string) if the IP number was not available.

virtual PBoolean PIPSocket::GetLocalAddress

(

Address &

addr

)

[virtual]

Parameters:

addr	Variable to receive hosts IP address

virtual PBoolean PIPSocket::GetLocalAddress	(	Address &	addr,
		WORD &	port
	)			[virtual]

Parameters:

addr	Variable to receive peer hosts IP address
port	Variable to receive peer hosts port number

virtual PString PIPSocket::GetPeerAddress

(

)

[virtual]

Get the Internet Protocol address for the peer host and port the socket is connected to.

Returns:

PFalse (or empty string) if the IP number was not available.

virtual PBoolean PIPSocket::GetPeerAddress

(

Address &

addr

)

[virtual]

Parameters:

addr	Variable to receive hosts IP address

virtual PBoolean PIPSocket::GetPeerAddress	(	Address &	addr,
		WORD &	port
	)			[virtual]

Parameters:

addr	Variable to receive peer hosts IP address
port	Variable to receive peer hosts port number

PString PIPSocket::GetLocalHostName

(

)

Get the host name for the local host.

Returns:

Name of the host, or an empty string if an error occurs.

PString PIPSocket::GetPeerHostName

(

)

Get the host name for the peer host the socket is connected to.

Returns:

Name of the host, or an empty string if an error occurs.

static void PIPSocket::ClearNameCache

(

)

[static]

Clear the name (DNS) cache.

static PBoolean PIPSocket::GetGatewayAddress

(

Address &

addr

)

[static]

Get the IP address that is being used as the gateway, that is, the computer that packets on the default route will be sent.

The string returned may be used in the Connect() function to open that interface.

Note that the driver does not need to be open for this function to work.

Returns:

PTrue if there was a gateway.

Parameters:

addr	Variable to receive the IP address.

static PString PIPSocket::GetGatewayInterface

(

)

[static]

Get the name for the interface that is being used as the gateway, that is, the interface that packets on the default route will be sent.

The string returned may be used in the Connect() function to open that interface.

Note that the driver does not need to be open for this function to work.

Returns:

String name of the gateway device, or empty string if there is none.

static PIPSocket::Address PIPSocket::GetRouteInterfaceAddress

(

PIPSocket::Address

remoteAddress

)

[static]

Get the interface address that will be used to reach the specified remote address. Uses longest prefix match when multiple matching interfaces are found.

Returns:

Network interface address.

PIPSocket::PARRAY	(	RouteTable	,
		RouteEntry
	)

static PBoolean PIPSocket::GetRouteTable

(

RouteTable &

table

)

[static]

Get the systems route table.

Returns:

PTrue if the route table is returned, PFalse if an error occurs.

Parameters:

table

Route table

static bool PIPSocket::WaitForRouteTableChange	(	const PTimeInterval &	timeout,
		PSyncPoint *	cancellation = NULL
	)			[static]

Wait for a change in the route table or network interfaces.

Returns:

true if a change occurred, false if timed out or cancelled.

Parameters:

timeout	Timeout for wait
cancellation	if sync point is signalled, wait is immediately terminated

PIPSocket::PARRAY	(	InterfaceTable	,
		InterfaceEntry
	)

static PBoolean PIPSocket::GetInterfaceTable	(	InterfaceTable &	table,
		PBoolean	includeDown = PFalse
	)			[static]

Get a list of all interfaces

Returns:

PTrue if the interface table is returned, PFalse if an error occurs.

Parameters:

table	interface table
includeDown	Include interfaces that are down

static PBoolean PIPSocket::GetNetworkInterface

(

PIPSocket::Address &

addr

)

[static]

Get the address of an interface that corresponds to a real network

Returns:

PFalse if only loopback interfaces could be found, else PTrue

PBoolean PIPSocket::SetCaptureReceiveToAddress

(

)

[inline]

Set flag to capture interface address for incoming packets

Returns:

PTrue if host is able to capture incoming address, else PFalse

PIPSocket::Address PIPSocket::GetLastReceiveToAddress

(

)

const [inline]

return the interface address of the last incoming packet

---

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

• ipsock.h

---