OLInternet6Address Class Reference
[Sockets]

An internet address for protocol version 6. More...

#import <ObjectiveLib/SocketAddress.h>

Inheritance diagram for OLInternet6Address:

[legend]List of all members.

Public Member Functions
(id)	- copy
	Make a copy of this socket address.
(OLText *)	- description
	Return a description of this address.
(const struct sockaddr *)	- hostRepresentation
	Return a platform-dependent representation of the address.
(unsigned)	- hostRepresentationLength
	Return the length of the host representation.
(BOOL)	- isEqual:
	Return whether this address is equal to another one.
(BOOL)	- isLocalWildcard
	Return whether this address is a local wildcard.
(uint16_t)	- port
	Return the port.
Initializers and Deallocators
(id)	- free
	Finalize the address and deallocate any allocated memory.
(id)	- init
	Initialize the address.
(id)	- initWithPort:
	Initialize the address.
Protected Attributes
sockaddr_in6 *	hostRep
	The host representation of the address.

---

Detailed Description

An internet address for protocol version 6.

This type of address can be used to communicate with a host via Internet protocol version 6.

Note:

This class will not be terribly useful if instantiated manually. The normal way to obtain an Internet address is to use one of the class methods from OLInternetAddress.

---

Member Function Documentation

- (id) copy

Make a copy of this socket address.

Returns:

the copy

Reimplemented from OLSocketAddress.

- (OLText*) description

Return a description of this address.

Return a description of this address.

A human-readable version of the address is returned. If a canonical name exists, then that name will be returned. Otherwise, a textual representation of the IP address and port number is returned.

Note:

If OpenStep is present the returned object will be autoreleased before being returned.

Returns:

the description of this address

Reimplemented from OLSocketAddress.

- (id) free

Finalize the address and deallocate any allocated memory.

Reimplemented from OLInternetAddress.

- (const struct sockaddr*) hostRepresentation

Return a platform-dependent representation of the address.

The returned data can be used in low-level socket operations and is intentionally opaque.

Returns:

the host representation

Reimplemented from OLSocketAddress.

- (unsigned) hostRepresentationLength

Return the length of the host representation.

The length of the structure returned by hostRepresentation is returned.

Returns:

the length of the host representation

Reimplemented from OLSocketAddress.

- (id) init

Initialize the address.

Initialize the address.

A local wildcard address is initialized with a port number of zero.

Returns:

a reference to this address

- (id) initWithPort:

(uint16_t)

port

Initialize the address.

Initialize the address.

A local wildcard address is created with the given port number.

Parameters:

port

the port of the address

Returns:

a reference to this address

- (BOOL) isEqual:

(id)

object

Return whether this address is equal to another one.

Parameters:

object

the object with which to compare this one

Returns:

YES if object is equal to this address, NO otherwise

- (BOOL) isLocalWildcard

Return whether this address is a local wildcard.

A local wildcard address is one that can refer to any of the current host's IP addresses without specifying exactly which one.

Returns:

YES if this is a wildcard address, NO if not

Reimplemented from OLInternetAddress.

- (uint16_t) port

Return the port.

Returns:

the port

Reimplemented from OLInternetAddress.

---

Member Data Documentation

- (struct sockaddr_in6*) hostRep [protected]

The host representation of the address.

---

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

• SocketAddress.h

---

Generated Sun Apr 22 15:18:40 2007, © 2004-2007 Will Mason