Index: /source/ariba/AribaModule.cpp =================================================================== --- /source/ariba/AribaModule.cpp (revision 7533) +++ /source/ariba/AribaModule.cpp (revision 7535) @@ -59,5 +59,6 @@ use_logging_cpp(AribaModule); -const string AribaModule::BootstrapMechanismNames[5] = {"invalid", "static", "broadcast", "mdns", "sdp"}; +const string AribaModule::BootstrapMechanismNames[5] + = {"invalid", "static", "broadcast", "mdns", "sdp"}; AribaModule::AribaModule() Index: /source/ariba/AribaModule.h =================================================================== --- /source/ariba/AribaModule.h (revision 7533) +++ /source/ariba/AribaModule.h (revision 7535) @@ -157,5 +157,7 @@ private: - // bootstrap mechanisms + /** + * Available bootstrap mechanisms + */ enum BootstrapMechanism { BootstrapMechanismInvalid = 0, @@ -167,5 +169,7 @@ static const string BootstrapMechanismNames[5]; - // bootstrap node + /** + * bootstrap node information + */ class BootstrapNode { public: @@ -189,5 +193,8 @@ }; - // bootstrap info + /* + * bootstrap info, all bootstrap nodes + * for a specific spovnet + */ class BootstrapInfo { public: @@ -203,5 +210,6 @@ vector nodes; }; - vector bootstrapNodes; + + vector bootstrapNodes; //< all available bootstrap information protected: @@ -210,5 +218,8 @@ bool started; //< flag, if module has been started - // bootstrap node management + /** + * bootstrap node management + * add a bootstrap node + */ void addBootstrapNode( const Name& spovnet, @@ -217,4 +228,9 @@ const BootstrapMechanism& mechanism ); + + /** + * bootstrap node management + * add a bootstrap node + */ void addBootstrapNode( const Name& spovnet, @@ -222,8 +238,18 @@ ); + /** + * bootstrap node management + * get all available bootstrap mechanisms + * where bootstrap nodes are available for + */ vector getBootstrapMechanisms( const Name& spovnet ) const; + /** + * get a endpoint descriptor for a spovnet + * using a specific bootstrap mechanisms. + * will currently only work with static + */ const communication::EndpointDescriptor* getBootstrapNode( const Name& spovnet, @@ -231,4 +257,8 @@ ) const; + /** + * get the info field associated for a given + * spovnet through a given mechanism + */ string getBootstrapInfo( const Name& spovnet, @@ -236,6 +266,6 @@ ) const; - communication::BaseCommunication* base_comm; - SideportListener* sideport_sniffer; + communication::BaseCommunication* base_comm; //< the base communication + SideportListener* sideport_sniffer; //< the sideport listener }; Index: /source/ariba/CommunicationListener.h =================================================================== --- /source/ariba/CommunicationListener.h (revision 7533) +++ /source/ariba/CommunicationListener.h (revision 7535) @@ -61,25 +61,63 @@ public: - static CommunicationListener DEFAULT; + static CommunicationListener DEFAULT; //< default implementation protected: + /** + * Construct a communication listener + */ CommunicationListener(); + + /** + * Destruct a communication listener + */ virtual ~CommunicationListener(); // --- link events --- + /** + * Event called when a link goes up + * @param lnk The id of the link + * @param remote The remote node where the link ends + */ virtual void onLinkUp(const LinkID& lnk, const NodeID& remote); + /** + * Event called when a link goes down + * @param lnk The id of the link + * @param remote The remote node where the link ends + */ virtual void onLinkDown(const LinkID& lnk, const NodeID& remote); + /** + * Event called when a link has changed, + * e.g. through mobility + * @param lnk The id of the link + * @param remote The remote node where the link ends + */ virtual void onLinkChanged(const LinkID& lnk, const NodeID& remote); + /** + * Event called when a link has failed + * @param lnk The id of the link + * @param remote The remote node where the link ends + */ virtual void onLinkFail(const LinkID& lnk, const NodeID& remote); + /** + * Request from remote node to open up a link + * @param remote The remote node that requests the new link + */ virtual bool onLinkRequest(const NodeID& remote); // --- general receive method --- + /** + * Called when a message is incoming + * @param msg The data message that is received + * @param remote The remote node that sent the message + * @param lnk The link id of the link where the message is received + */ virtual void onMessage(const DataMessage& msg, const NodeID& remote, const LinkID& lnk = LinkID::UNSPECIFIED); @@ -87,4 +125,9 @@ // --- dht functionality --- + /** + * Called when a key has been resolved in the DHT + * @param key The key that was requested + * @param value the data items the key was resolved to + */ virtual void onKeyValue( const Data& key, const vector& value ); Index: /source/ariba/DataMessage.h =================================================================== --- /source/ariba/DataMessage.h (revision 7533) +++ /source/ariba/DataMessage.h (revision 7535) @@ -33,9 +33,12 @@ class DataMessage { private: - void* data; - size_t size; + void* data; //< internal buffer pointer + size_t size; //< internal buffer pointer size public: - static const DataMessage UNSPECIFIED; + static const DataMessage UNSPECIFIED; //< default implementation of a data message + /** + * Default constructor for a data message + */ inline DataMessage() { this->data = NULL; @@ -43,4 +46,9 @@ } + /** + * Constructor for a data message + * @param data Data buffer to carry in the message + * @param size Size of the buffer pointed to + */ inline DataMessage( const void* data, const size_t size ) { this->data = const_cast(data); @@ -48,4 +56,8 @@ } + /** + * Copy constructor for a data message + * @param message The other message to copy from + */ inline DataMessage(const DataMessage& message){ this->data = message.data; @@ -54,4 +66,8 @@ #ifdef USE_MESSAGE_UTILITY + /** + * Construct a data message from a normal message + * @param message The normal message to store + */ inline DataMessage( const Message* message ) { this->data = (void*)const_cast(message); @@ -59,4 +75,8 @@ } + /** + * Construct a data message from a normal message + * @param message The normal message to store + */ inline DataMessage( const Message& message ) { this->data = (void*)const_cast(&message); @@ -64,4 +84,8 @@ } + /** + * Get the internal message when constructued through one + * @return pointer to the message + */ inline Message* getMessage() const { if (isData()) { @@ -71,4 +95,8 @@ } + /** + * Conversion function to convert to Message* + * @return internal message + */ inline operator Message* () const { return getMessage(); @@ -76,23 +104,44 @@ #endif + /** + * Is the data message a normal message? + * @return true, if the data message is a normal message + */ inline bool isMessage() const { return size == ~(size_t)0; } + /** + * Is the data message a data message + * @return true, if the data message is not a normal message + */ inline bool isData() const { return !isMessage(); } + /** + * Directly access the internal data pointer + * @return internal data pointer + */ inline void* getData() const { return data; } + /** + * Get the size of the internal buffer + * @return internal buffer size + */ inline size_t getSize() const { return size; } + /** + * Is the data message invalid? + * @return true, if data message is invalid + */ inline bool isUnspecified() const { return data == NULL; } + }; Index: /source/ariba/LinkProperties.h =================================================================== --- /source/ariba/LinkProperties.h (revision 7533) +++ /source/ariba/LinkProperties.h (revision 7535) @@ -53,10 +53,29 @@ namespace ariba { +/** + * Link properties storage. Currently empty but will + * contain properties to create the link in the future + */ class LinkProperties { public: + /** + * Constructor of LinkProperties + */ LinkProperties(); - ~LinkProperties(); + /** + * Destructor of LinkProperties + */ + virtual ~LinkProperties(); + + /** + * Convert to readable string + * @return string representation + */ string toString() const; + + /** + * Default instance of LinkProperties + */ static const LinkProperties DEFAULT; }; Index: /source/ariba/Message.h =================================================================== --- /source/ariba/Message.h (revision 7533) +++ /source/ariba/Message.h (revision 7535) @@ -40,6 +40,4 @@ #define TIDYMESSAGE_H_ -/** THIS FILE IS ABOUT TO BE DEPRECATED !! */ - #include #include "ariba/utility/messages.h" Index: /source/ariba/Name.h =================================================================== --- /source/ariba/Name.h (revision 7533) +++ /source/ariba/Name.h (revision 7535) @@ -149,8 +149,8 @@ private: - uint8_t* _bytes; - int _length; - bool _copy; - bool _hreadable; + uint8_t* _bytes; //< internal pointer + int _length; //< length of internal pointer + bool _copy; //< is the buffer a real copy + bool _hreadable; //< is the name human readable void init(const char* name, int len, bool copy, bool hreadable); Index: /source/ariba/Node.h =================================================================== --- /source/ariba/Node.h (revision 7533) +++ /source/ariba/Node.h (revision 7535) @@ -182,6 +182,4 @@ * the node name of the remote node, if known -- otherwise it returns * an unspecified name. - * - * TODO: RFE -- send request to remote node and inform service. * * @return A node's name or an unspecified name, if unknown @@ -325,5 +323,4 @@ string getName() const; - protected: // friends @@ -334,6 +331,7 @@ AribaModule& ariba_mod; //< ariba module SpoVNetID spovnetId; //< current spovnet id - NodeID nodeId; //< current node id + NodeID nodeId; //< current node id overlay::BaseOverlay* base_overlay; //< the base overlay + }; Index: /source/ariba/SpoVNetProperties.h =================================================================== --- /source/ariba/SpoVNetProperties.h (revision 7533) +++ /source/ariba/SpoVNetProperties.h (revision 7535) @@ -66,4 +66,7 @@ class SpoVNetProperties { public: + /** + * Different types of overlays that are supported + */ enum OverlayType { ONE_HOP_OVERLAY = 0,