00001
00002
00003
00004
00005
00006
00007
00008
00009
00010
00011
00012
00013
00014
00015
00016
00017
00018
00019
00020
00021
00022
00023
00024
00025
00026
00027
00028
00029
00030
00031
00032
00033
00034
00035
00036
00037
00038
00039 #ifndef __OVERLAY_INTERFACE_H
00040 #define __OVERLAY_INTERFACE_H
00041
00042 #include "ariba/CommunicationListener.h"
00043 #include "ariba/communication/EndpointDescriptor.h"
00044 #include "ariba/overlay/modules/OverlayStructureEvents.h"
00045 #include "ariba/utility/types/NodeID.h"
00046 #include "ariba/utility/types/ServiceID.h"
00047 #include "ariba/utility/types/OverlayParameterSet.h"
00048
00049 using ariba::CommunicationListener;
00050 using ariba::communication::EndpointDescriptor;
00051 using ariba::overlay::OverlayStructureEvents;
00052 using ariba::utility::NodeID;
00053 using ariba::utility::ServiceID;
00054 using ariba::utility::OverlayParameterSet;
00055
00056 namespace ariba {
00057 namespace overlay {
00058
00059 class BaseOverlay;
00060
00064 class OverlayInterface: public CommunicationListener {
00065 friend class BaseOverlay;
00066
00067 public:
00071 typedef vector<NodeID> NodeList;
00072
00076 OverlayInterface( BaseOverlay& _baseoverlay, const NodeID& _nodeid,
00077 OverlayStructureEvents* _eventsReceiver, OverlayParameterSet _parameters
00078 );
00079
00083 virtual ~OverlayInterface();
00084
00088 virtual void createOverlay() = 0;
00089
00093 virtual void deleteOverlay() = 0;
00094
00102 virtual void joinOverlay(
00103 const EndpointDescriptor& bootstrap = EndpointDescriptor::UNSPECIFIED()) = 0;
00104
00108 virtual void leaveOverlay() = 0;
00109
00116 virtual const EndpointDescriptor& resolveNode(const NodeID& node) = 0;
00117
00118
00126 virtual bool isClosestNodeTo( const NodeID& node ) = 0;
00127
00138 virtual NodeList getKnownNodes(bool deep = true) const = 0;
00139
00146 virtual const LinkID& getNextLinkId( const NodeID& id ) const = 0;
00147
00148
00149
00151 virtual void onLinkUp(const LinkID& lnk, const NodeID& remote);
00152
00154 virtual void onLinkDown(const LinkID& lnk, const NodeID& remote);
00155
00157 virtual void onLinkChanged(const LinkID& lnk, const NodeID& remote);
00158
00160 virtual void onLinkFail(const LinkID& lnk, const NodeID& remote);
00161
00163 virtual void onLinkQoSChanged(const LinkID& lnk, const NodeID& remote,
00164 const LinkProperties& prop);
00165
00167 virtual bool onLinkRequest(const NodeID& remote, const DataMessage& msg);
00168
00170 virtual void onMessage(const DataMessage& msg, const NodeID& remote,
00171 const LinkID& lnk = LinkID::UNSPECIFIED);
00172
00173 const OverlayParameterSet& getParameters() const;
00174
00175 virtual std::string debugInformation() const;
00176
00177 protected:
00179 BaseOverlay& baseoverlay;
00180
00182 const NodeID& nodeid;
00183
00185 OverlayStructureEvents* eventsReceiver;
00186
00188 OverlayParameterSet parameters;
00189
00191 static ServiceID OVERLAY_SERVICE_ID;
00192 };
00193
00194 }}
00195
00196 #endif // __OVERLAY_INTERFACE_H