Edit

CSocketAddr Class

  • Article

This class provides methods for converting host names to host addresses, supporting both IPv4 and IPV6 formats.

Syntax

class CSocketAddr

Members

Public Constructors

Name Description
CSocketAddr::CSocketAddr The constructor.

Public Methods

Name Description
CSocketAddr::FindAddr Call this method to convert the provided host name to the host address.
CSocketAddr::FindINET4Addr Call this method to convert the IPv4 host name to the host address.
CSocketAddr::FindINET6Addr Call this method to convert the IPv6 host name to the host address.
CSocketAddr::GetAddrInfo Call this method to return a pointer to a specific element in the addrinfo list.
CSocketAddr::GetAddrInfoList Call this method to return a pointer to the addrinfo list.

Remarks

This class provides an IP version agnostic approach for looking up network addresses for use with Windows sockets API functions and socket wrappers in libraries.

The members of this class that are used to look up network addresses use the Win32 API function getaddrinfo. The ANSI or UNICODE version of the function is called depending on whether your code is compiled for ANSI or UNICODE.

This class supports both IPv4 andIPv6 network addresses.

Requirements

Header: atlsocket.h

CSocketAddr::CSocketAddr

The constructor.

CSocketAddr();

Remarks

Creates a new CSocketAddr object and initializes the linked list containing response information about the host.

CSocketAddr::FindAddr

Call this method to convert the provided host name to the host address.

int FindAddr(
    const TCHAR *szHost,
    const TCHAR *szPortOrServiceName,
    int flags,
    int addr_family,
    int sock_type,
    int ai_proto);

int FindAddr(
    const TCHAR *szHost,
    int nPortNo,
    int flags,
    int addr_family,
    int sock_type,
    int ai_proto);

Parameters

szHost
The host name or dotted IP address.

szPortOrServiceName
The port number or name of service on host.

nPortNo
The port number.

flags
0 or combination of AI_PASSIVE, AI_CANONNAME or AI_NUMERICHOST.

addr_family
Address family (such as PF_INET).

sock_type
Socket type (such as SOCK_STREAM).

ai_proto
Protocol (such as IPPROTO_IP or IPPROTO_IPV6).

Return Value

Returns zero if the address is calculated successfully. Returns a nonzero Windows Socket error code on failure. If successful, the calculated address is stored in a linked list that may be referenced using CSocketAddr::GetAddrInfoList and CSocketAddr::GetAddrInfo.

Remarks

The host name parameter may be in either IPv4 or IPv6 format. This method calls the Win32 API function getaddrinfo to perform the conversion.

CSocketAddr::FindINET4Addr

Call this method to convert the IPv4 host name to the host address.

int FindINET4Addr(
    const TCHAR *szHost,
    int nPortNo,
    int flags = 0,
    int sock_type = SOCK_STREAM);

Parameters

szHost
The host name or dotted IP address.

nPortNo
The port number.

flags
0 or combination of AI_PASSIVE, AI_CANONNAME or AI_NUMERICHOST.

sock_type
Socket type (such as SOCK_STREAM).

Return Value

Returns zero if the address is calculated successfully. Returns a nonzero Windows Socket error code on failure. If successful, the calculated address is stored in a linked list that may be referenced using CSocketAddr::GetAddrInfoList and CSocketAddr::GetAddrInfo.

Remarks

This method calls the Win32 API function getaddrinfo to perform the conversion.

CSocketAddr::FindINET6Addr

Call this method to convert the IPv6 host name to the host address.

int FindINET6Addr(
    const TCHAR *szHost,
    int nPortNo,
    int flags = 0,
    int sock_type = SOCK_STREAM);

Parameters

szHost
The host name or dotted IP address.

nPortNo
The port number.

flags
0 or combination of AI_PASSIVE, AI_CANONNAME or AI_NUMERICHOST.

sock_type
Socket type (such as SOCK_STREAM).

Return Value

Returns zero if the address is calculated successfully. Returns a nonzero Windows Socket error code on failure. If successful, the calculated address is stored in a linked list that may be referenced using CSocketAddr::GetAddrInfoList and CSocketAddr::GetAddrInfo.

Remarks

This method calls the Win32 API function getaddrinfo to perform the conversion.

CSocketAddr::GetAddrInfo

Call this method to return a pointer to a specific element in the addrinfo list.

addrinfo* const GetAddrInfo(int nIndex = 0) const;

Parameters

nIndex
A reference to a specific element in the addrinfo list.

Return Value

Returns a pointer to the addrinfo structure referenced by nIndex in the linked list containing response information about the host.

CSocketAddr::GetAddrInfoList

Call this method to return a pointer to the addrinfo list.

addrinfo* const GetAddrInfoList() const;

Return Value

Pointer to a linked list of one or more addrinfo structures containing response information about the host. For more information, see addrinfo structure.

See also

Class Overview