SocketAddress.h

Go to the documentation of this file.

// SocketAddress.h: interface for the SocketAddress class

#ifndef SOCKETADDRESS_H_
#define SOCKETADDRESS_H_

#ifdef _MSC_VER
#pragma once
#endif // MSVC

#include <iosfwd>
#include <string>

#include "SocketIncludes.h"

class IpAddress;

// SocketAddress

class SocketAddress
{
public:
        // Construct from port number
        SocketAddress( int port = 0 );

        // Construct from the given IpAddress and port number
        SocketAddress( const IpAddress& address, int port = 0 );


        // Construct from Berkley Socket sockaddr_in structure
        SocketAddress( const sockaddr_in& address );

        // Copy constructor
        SocketAddress( const SocketAddress& socket_address );

        // Assignment from a Berkley Socket sockaddr_in structure
        SocketAddress& operator=( const sockaddr_in& address );

        // Assignment operator
        SocketAddress& operator=( const SocketAddress& address );

        // Comparison to another Socket Address
        bool operator==( const SocketAddress& address ) const;

        // Comparison to another Socket Address
        bool operator<( const SocketAddress& address ) const;

        // Standard c++ iostream inserter
        std::ostream& operator<<( std::ostream& stream) const;

        // Convert to Berkley Socket sockaddr_in structure
        operator sockaddr_in() const;

        // Port number accessors
        int getPort() const;
        void setPort( int port );

        // Ip address accessors
        IpAddress getIpAddress() const;
        void setIpAddress( const IpAddress& address );

        // Address family
        // On Win32 this should always be the AF_INET constant
        short getAddressFamily() const;

        // Validity test for SocketAddress
        bool isDefined() const;

        // Whether SocketAddress is an IpAddress
        bool isIpAddress() const;

        // Whether the SocketAddress is path based
        bool isPathAddress() const;


protected:
        // Convert IpAddress to long
        long getIpAddressAsLong() const;

        // Set the IpAddress
        void setIpAddress(long code);

        // Internal information.
        int length() const;

        // Perfrom address initialization
        void initialize();

private:
        // Berkley Sockets socket address structure.
        sockaddr_in socketAddress;
};

#endif // SocketAddress

---