source: source/ariba/communication/EndpointDescriptor.h @ 5412

// [License]
// The Ariba-Underlay Copyright
//
// Copyright (c) 2008-2009, Institute of Telematics, UniversitÀt Karlsruhe (TH)
//
// Institute of Telematics
// UniversitÀt Karlsruhe (TH)
// Zirkel 2, 76128 Karlsruhe
// Germany
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE INSTITUTE OF TELEMATICS ``AS IS'' AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE ARIBA PROJECT OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// The views and conclusions contained in the software and documentation
// are those of the authors and should not be interpreted as representing
// official policies, either expressed or implied, of the Institute of
// Telematics.
// [License]

#ifndef ENDPOINTDESCRIPTOR_H_
#define ENDPOINTDESCRIPTOR_H_

// deprecated
//#include "ariba/communication/modules/network/ip/IPv4Locator.h"

// deprecated
//using ariba::utility::Locator;
//using ariba::communication::IPv4Locator;

// typical types
#include "ariba/utility/types.h"
#include "ariba/utility/serialization.h"

// new addressing and transport
#include "ariba/utility/addressing/addressing.hpp"
#include "ariba/utility/transport/transport.hpp"

// stdlibc++
#include <string>
#include <set>

namespace ariba {
namespace communication {

using_serialization;
using namespace std;
using namespace ariba::addressing;

class EndpointDescriptor: public VSerializeable { VSERIALIZEABLE
        friend class BaseCommunication;

public:
        /// the unspecified endpoint descriptor
        static const EndpointDescriptor UNSPECIFIED;

        /// creates an empty endpoint descriptor with zero endpoints
        EndpointDescriptor() : endpoints() {
        }

        /// destructor.
        virtual ~EndpointDescriptor();

        /// copy constructor
        EndpointDescriptor(const EndpointDescriptor& rh) :
                endpoints(rh.endpoints) {
        }

        /// construct end-points from an endpoint set
        EndpointDescriptor(const endpoint_set& endpoints ) :
                endpoints(endpoints) {
        }

        /// construct end-points from a string
        EndpointDescriptor(const string& str) : endpoints(str) {
        }

        /// convert end-points to string
        string toString() const {
                return endpoints.to_string();
        }

        /// returns true, if this object is the unspecified object
        bool isUnspecified() const {
                return this == &UNSPECIFIED;
        }

        /// create endpoint
        static EndpointDescriptor* fromString(string str) {
                return new EndpointDescriptor(str);
        }

        bool operator==(const EndpointDescriptor& rh) const {
                if (rh.isUnspecified() && isUnspecified()) return true;
                if (rh.isUnspecified() ^  isUnspecified()) return false;

                assert( (!rh.isUnspecified()) && (!isUnspecified()) );
                return endpoints == rh.endpoints;
        }

        bool operator!=(const EndpointDescriptor& rh) const {
                return ( !operator==(rh) );
        }

        EndpointDescriptor& operator=( const EndpointDescriptor& rhs) {
                endpoints = rhs.endpoints;
        }

        /// returns the end-points of this descriptor
        endpoint_set& getEndpoints() {
                return endpoints;
        }

        /// returns the end-points of this descriptor
        const endpoint_set& getEndpoints() const {
                return endpoints;
        }

private:
        endpoint_set endpoints;
};

}} // namespace ariba, communication

sznBeginDefault( ariba::communication::EndpointDescriptor, X ){
        // serialize endpoints
        uint16_t len = endpoints.to_bytes_size();
        X && len;
        uint8_t* buffer = X.bytes( len );
        if (buffer!=NULL) {
                if (X.isDeserializer()) endpoints.assign(buffer,len);
                else endpoints.to_bytes(buffer);
        }
}sznEnd();

#endif /*ENDPOINTDESCRIPTOR_H_*/