Git-Mirrors/RetroShare
1
0
Fork 0
mirror of https://github.com/RetroShare/RetroShare.git synced 2024-12-25 07:29:33 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

initialial doxygen documentation

Browse Source 
git-svn-id: http://svn.code.sf.net/p/retroshare/code/trunk@289 b45a01b8-16f6-495d-af2f-9b41ad6348cc
This commit is contained in:
chrisparker126 2008-01-10 22:19:00 +00:00
parent bbd3c17b6d
commit 983efff1c0
1 changed files with 33 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
libretroshare/src/serialiser/rstlvtypes.h
View File

@ -36,6 +36,10 @@
#define RS_TLV_TYPE_FILE_ITEM 0x0000 #define RS_TLV_TYPE_FILE_ITEM 0x0000
//! A base class for all tlv items
/*! This class is provided to allow the serialisation and deserialization of compund
tlv items
*/
class RsTlvItem class RsTlvItem
{ {
public: public:
@ -52,23 +56,29 @@ std::ostream &printEnd(std::ostream &out, std::string clsName, uint16_t indent);
std::ostream &printIndent(std::ostream &out, uint16_t indent); std::ostream &printIndent(std::ostream &out, uint16_t indent);
/**** GENERIC Binary Data TLV ****/ //! GENERIC Binary Data TLV
/*! Use to serialise and deserialise binary data, usually included in other compound tlvs
*/
class RsTlvBinaryData: public RsTlvItem class RsTlvBinaryData: public RsTlvItem
{ {
public: public:
RsTlvBinaryData(uint16_t t); RsTlvBinaryData(uint16_t t);
virtual ~RsTlvBinaryData() { return;} virtual ~RsTlvBinaryData() { return;}
virtual uint16_t TlvSize(); virtual uint16_t TlvSize();
virtual void TlvClear(); virtual void TlvClear(); /*! Initialize fields to empty legal values ( "0", "", etc) */
virtual bool SetTlv(void *data, uint32_t size, uint32_t *offset); /* serialise */ /// Serialise.
virtual bool GetTlv(void *data, uint32_t size, uint32_t *offset); /* deserialise */ /*! Serialise Tlv to buffer(*data) of 'size' bytes starting at *offset */
virtual std::ostream &print(std::ostream &out, uint16_t indent); virtual bool SetTlv(void *data, uint32_t size, uint32_t *offset);
/// Deserialise.
/*! Deserialise Tlv buffer(*data) of 'size' bytes starting at *offset */
virtual bool GetTlv(void *data, uint32_t size, uint32_t *offset);
virtual std::ostream &print(std::ostream &out, uint16_t indent); /*! Error/Debug util function */
bool setBinData(void *data, uint16_t size); bool setBinData(void *data, uint16_t size);
uint16_t tlvtype; /* set/checked against TLV input */ uint16_t tlvtype; /// set/checked against TLV input
uint16_t bin_len; /* size of malloc'ed data (not serialised) */ uint16_t bin_len; /// size of malloc'ed data (not serialised)
void *bin_data; /* manditory: */ void *bin_data; /// mandatory
}; };
class RsTlvFileItem: public RsTlvItem class RsTlvFileItem: public RsTlvItem
@ -82,12 +92,12 @@ virtual bool SetTlv(void *data, uint32_t size, uint32_t *offset); /* seriali
virtual bool GetTlv(void *data, uint32_t size, uint32_t *offset); /* deserialise */ virtual bool GetTlv(void *data, uint32_t size, uint32_t *offset); /* deserialise */
virtual std::ostream &print(std::ostream &out, uint16_t indent); virtual std::ostream &print(std::ostream &out, uint16_t indent);
uint64_t filesize; /* Mandatory */ uint64_t filesize; /// Mandatory: size of file to be downloaded
std::string hash; /* Mandatory */ std::string hash; /// Mandatory: to find file
std::string name; /* Optional */ std::string name; /// Optional: name of file
std::string path; /* Optional */ std::string path; /// Optional: path on host computer
uint32_t pop; /* Optional */ uint32_t pop; /// Optional: Popularity of file
uint32_t age; /* Optional */ uint32_t age; /// Optional: age of file
}; };
class RsTlvFileSet: public RsTlvItem class RsTlvFileSet: public RsTlvItem
@ -101,9 +111,9 @@ virtual bool SetTlv(void *data, uint32_t size, uint32_t *offset); /* seriali
virtual bool GetTlv(void *data, uint32_t size, uint32_t *offset); /* deserialise */ virtual bool GetTlv(void *data, uint32_t size, uint32_t *offset); /* deserialise */
virtual std::ostream &print(std::ostream &out, uint16_t indent); virtual std::ostream &print(std::ostream &out, uint16_t indent);
std::list<RsTlvFileItem> items; /* Mandatory */ std::list<RsTlvFileItem> items; /// Mandatory
std::string title; /* Optional */ std::string title; /// Optional: title of file set
std::string comment; /* Optional */ std::string comment; /// Optional: comments for file
}; };
@ -118,9 +128,9 @@ virtual bool SetTlv(void *data, uint32_t size, uint32_t *offset); /* seriali
virtual bool GetTlv(void *data, uint32_t size, uint32_t *offset); /* deserialise */ virtual bool GetTlv(void *data, uint32_t size, uint32_t *offset); /* deserialise */
virtual std::ostream &print(std::ostream &out, uint16_t indent); virtual std::ostream &print(std::ostream &out, uint16_t indent);
RsTlvFileItem file; /* Mandatory */ RsTlvFileItem file; /// Mandatory: file information
uint64_t file_offset; /* Mandatory */ uint64_t file_offset; /// Mandatory: where to start in bin data
RsTlvBinaryData binData; /* Mandatory */ RsTlvBinaryData binData; /// Mandatory: serialised file info
}; };
@ -179,8 +189,8 @@ virtual bool SetTlv(void *data, uint32_t size, uint32_t *offset); /* seriali
virtual bool GetTlv(void *data, uint32_t size, uint32_t *offset); /* deserialise */ virtual bool GetTlv(void *data, uint32_t size, uint32_t *offset); /* deserialise */
virtual std::ostream &print(std::ostream &out, uint16_t indent); virtual std::ostream &print(std::ostream &out, uint16_t indent);
std::string key; /* Mandatory */ std::string key; /// Mandatory : For use in hash tables
std::string value; /* Mandatory */ std::string value; /// Mandatory : For use in hash tables
}; };
class RsTlvKeyValueSet: public RsTlvItem class RsTlvKeyValueSet: public RsTlvItem
@ -194,7 +204,7 @@ virtual bool SetTlv(void *data, uint32_t size, uint32_t *offset); /* seriali
virtual bool GetTlv(void *data, uint32_t size, uint32_t *offset); /* deserialise */ virtual bool GetTlv(void *data, uint32_t size, uint32_t *offset); /* deserialise */
virtual std::ostream &print(std::ostream &out, uint16_t indent); virtual std::ostream &print(std::ostream &out, uint16_t indent);
std::list<RsTlvKeyValue> pairs; /* Mandatory */ std::list<RsTlvKeyValue> pairs; /// For use in hash tables
}; };