opentxs::OTPayload Class Reference

#include <OTPayload.hpp>

Inheritance diagram for opentxs::OTPayload:

Collaboration diagram for opentxs::OTPayload:

Public Member Functions
EXPORT	OTPayload ()
	OTPayload (const void *pNewData, uint32_t nNewSize)
	OTPayload (const OTPayload &rhs)
	OTPayload (const OTASCIIArmor &theSource)
virtual EXPORT	~OTPayload ()
EXPORT uint32_t	ReadBytesFrom (OTData &theData, uint32_t lSize)
EXPORT void	SetPayloadSize (uint32_t lNewSize)
EXPORT const void *	GetPayloadPointer () const
EXPORT bool	SetMessagePayload (const OTMessage &theMessage)
EXPORT bool	GetMessagePayload (OTMessage &theMessage) const
EXPORT bool	GetEnvelope (OTEnvelope &theEnvelope) const
EXPORT bool	SetEnvelope (const OTEnvelope &theEnvelope)
Public Member Functions inherited from opentxs::OTData
EXPORT	OTData ()
EXPORT	OTData (const void *data, uint32_t size)
EXPORT	OTData (const OTData &source)
EXPORT	OTData (const OTASCIIArmor &source)
virtual EXPORT	~OTData ()
virtual EXPORT void	Release ()
EXPORT void	Release_Data ()
void	SetSize (uint32_t size)
const void *	GetPointer () const
EXPORT OTData &	operator= (OTData rhs)
EXPORT void	swap (OTData &rhs)
EXPORT bool	operator== (const OTData &rhs) const
EXPORT bool	operator!= (const OTData &rhs) const
EXPORT OTData &	operator+= (const OTData &rhs)
EXPORT bool	IsEmpty () const
uint32_t	GetSize () const
EXPORT void	Assign (const OTData &source)
EXPORT void	Assign (const void *data, uint32_t size)
EXPORT void	Concatenate (const void *data, uint32_t size)
EXPORT bool	Randomize (uint32_t size)
EXPORT void	zeroMemory () const
EXPORT uint32_t	OTfread (uint8_t *data, uint32_t size)
void	reset ()

Additional Inherited Members
Protected Member Functions inherited from opentxs::OTData
void	Initialize ()

Detailed Description

Definition at line 145 of file OTPayload.hpp.

Constructor & Destructor Documentation

opentxs::OTPayload::OTPayload

(

)

Definition at line 145 of file OTPayload.cpp.

    : OTData()
{
}

opentxs::OTPayload::OTPayload	(	const void *	pNewData,
		uint32_t	nNewSize
	)

Definition at line 150 of file OTPayload.cpp.

    : OTData(pNewData, nNewSize)
{
}

opentxs::OTPayload::OTPayload

(

const OTPayload &

rhs

)

Definition at line 155 of file OTPayload.cpp.

    : OTData(rhs)
{
}

opentxs::OTPayload::OTPayload

(

const OTASCIIArmor &

theSource

)

Definition at line 160 of file OTPayload.cpp.

    : OTData(theSource)
{
}

opentxs::OTPayload::~OTPayload ( )

virtual

Definition at line 165 of file OTPayload.cpp.

{
}

Member Function Documentation

bool opentxs::OTPayload::GetEnvelope

(

OTEnvelope &

theEnvelope

)

const

Definition at line 232 of file OTPayload.cpp.

{
    // validate checksum
    uint32_t lSize = GetSize();
    uint32_t lIndex = lSize - 2; // the index to where the nullptr terminator
                                 // SHOULD be if they
    // sent us a base64-encoded string, containing an encrypted message. (which
    // we expect...)

    // (lSize-1 would be the location of the checksum at the end.)
    if (0 == lSize) return false;

    if (IsChecksumValid((OT_BYTE*)GetPointer(), (uint32_t)lSize)) {
        // We add the null-terminator ourselves at this point, for security
        // reasons,
        // since we will process the data, soon after this function, as a
        // string.
        ((OT_BYTE*)GetPointer())[lIndex] = 0;

        theEnvelope.m_dataContents.Release();

        OTASCIIArmor theArmor;
        // Why is this safe, where I cast the Payload data pointer as
        // a char * and tell the data object to set itself from that?
        // Because (1) I just validated the checksum, and
        // (2) There place where the nullptr should be, I set to 0, by hand,
        // just above 2 lines. So when this set operation occurs, the
        // farthest it will go is to that 0.
        theArmor.Set((const char*)GetPointer());

        // Todo NOTE: If I ever want to process bookends here instead of
        // assuming they aren't there,
        // IT'S VERY EASY!! All I have to do is call theArmor.LoadFromString
        // instead of theArmor.Set.

        // Now the ascii-armored string that was sent across is decoded back to
        // binary into the
        // Envelope object.
        theEnvelope.SetAsciiArmoredData(theArmor);
        return true;
    }
    else {
        otErr << "Invalid Checksum in OTPayload::GetEnvelope\n";
        return false;
    }
}

bool opentxs::OTPayload::GetMessagePayload

(

OTMessage &

theMessage

)

const

Definition at line 280 of file OTPayload.cpp.

{
    // validate checksum
    uint32_t lSize = GetSize();
    uint32_t lIndex = lSize - 2; // the index to where the nullptr terminator
                                 // SHOULD be if they
    // sent us a string like they were supposed to. (A contract.)
    // (nSize-1 would be the location of the checksum at the end.)
    if (0 == lSize) return false;

    if (IsChecksumValid((OT_BYTE*)GetPointer(), (uint32_t)lSize)) {
        // We add the null-terminator ourselves at this point, for security
        // reasons,
        // since we will process the data, after this point, as a string.
        ((OT_BYTE*)GetPointer())[lIndex] = 0;

        theMessage.Release();

        // Why is this safe, where I cast the Payload data pointer as
        // a char * and tell the string to set itself from that?
        // Because (1) I just validated the checksum, and
        // (2) There place where the nullptr should be, I set to 0, by hand,
        // just above 2 lines. So when this set operation occurs, the
        // farthest it will go is to that 0.
        theMessage.m_strRawFile.Set((const char*)GetPointer());
        return true;
    }
    else {
        otErr << "Invalid Checksum in OTPayload::GetMessage\n";
        return false;
    }
}

const void * opentxs::OTPayload::GetPayloadPointer

(

)

const

Definition at line 318 of file OTPayload.cpp.

{
    return GetPointer();
}

uint32_t opentxs::OTPayload::ReadBytesFrom	(	OTData &	theData,
		uint32_t	lSize
	)

Definition at line 169 of file OTPayload.cpp.

{
    OT_ASSERT(theData.GetSize() >= lSize);

    // The size requested to read MUST be less or equal to size of theData
    if (theData.GetSize() < lSize) abort();

    OTPayload& refPayload = (OTPayload&)theData; // todo fix this cast.

    // Copy from theData to this, up until lSize
    Assign(refPayload.GetPayloadPointer(), lSize);

    // Create a temp var, starting from theData+lSize, copying to the end of
    // theData
    OTData TEMPdata((uint8_t*)refPayload.GetPayloadPointer() + lSize,
                    theData.GetSize() - lSize);

    // theData is assigned to TEMPdata (thus removing from it the bytes that we
    // just read into this.)
    theData.Assign(TEMPdata);

    return lSize;
}

bool opentxs::OTPayload::SetEnvelope

(

const OTEnvelope &

theEnvelope

)

Definition at line 194 of file OTPayload.cpp.

{
    OTASCIIArmor theArmor;

    if (theEnvelope.GetAsciiArmoredData(theArmor)) {
        uint32_t lSize = theArmor.GetLength() + 1; //+1 for the null terminater

        if (theArmor.GetLength()) {
            SetPayloadSize(lSize + 1); // +1 for the checksum byte.

            // Copy it in.
            memcpy((void*)GetPointer(), theArmor.Get(), lSize);

            // Add the checksum, success.
            AppendChecksum((OT_BYTE*)GetPointer(), lSize);
            return true;
        }
    }
    return false;
}

bool opentxs::OTPayload::SetMessagePayload

(

const OTMessage &

theMessage

)

Definition at line 215 of file OTPayload.cpp.

{
    uint32_t lSize =
        theMessage.m_strRawFile.GetLength() + 1; //+1 for the null terminater

    if (theMessage.m_strRawFile.GetLength()) {
        SetPayloadSize(lSize + 1); // +1 for the checksum byte.
        memcpy((void*)GetPointer(), theMessage.m_strRawFile.Get(), lSize);

        // Add the checksum
        AppendChecksum((OT_BYTE*)GetPointer(), lSize);
        return true;
    }
    return false;
}

void opentxs::OTPayload::SetPayloadSize

(

uint32_t

lNewSize

)

Definition at line 313 of file OTPayload.cpp.

{
    SetSize(lNewSize);
}

---

The documentation for this class was generated from the following files:

• /usr/local/src/opentxs/include/opentxs/core/OTPayload.hpp
• /usr/local/src/opentxs/src/core/OTPayload.cpp