OLSocketAddress Class Reference
[Sockets]

An address suitable for use with sockets. More...

#import <ObjectiveLib/SocketAddress.h>

Inheritance diagram for OLSocketAddress:

Inheritance graph
[legend]
List of all members.

Public Member Functions

(id) - copyWithZone:
 Make a copy of this socket address allocating memory from zone.
(OLText *) - description
 Return a description of the socket address.
(unsigned) - hash
 Return the hash code of this socket address.
(const struct sockaddr *) - hostRepresentation
 Return a platform-dependent representation of the address.
(unsigned) - hostRepresentationLength
 Return the length of the host representation.

Detailed Description

An address suitable for use with sockets.

This base class provides common functionality shared by all addresses.


Member Function Documentation

- (id) copyWithZone: (NSZone *)  zone  

Make a copy of this socket address allocating memory from zone.

Parameters:
zone the zone from which to allocate memory
Returns:
the copy

Reimplemented in OLInternet4Address, OLInternet6Address, and OLUnixAddress.

- (OLText*) description  

Return a description of the socket address.

The nature of the description will depend on the type of socket address.

Note:
If OpenStep is present the returned object will be autoreleased before being returned.
Returns:
the description

Reimplemented in OLInternet4Address, OLInternet6Address, and OLUnixAddress.

- (unsigned) hash  

Return the hash code of this socket address.

The hash code is computed using OLHash.

Returns:
the hash code

- (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 in OLInternet4Address, OLInternet6Address, and OLUnixAddress.

- (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 in OLInternet4Address, OLInternet6Address, and OLUnixAddress.


The documentation for this class was generated from the following file:
ObjectiveLibGenerated Sun Apr 22 15:13:49 2007, © 2004-2007 Will Mason
SourceForge.net Logo