CP_Base64Encoder Class Reference

CP_Base64Encoder. More...

Inheritance diagram for CP_Base64Encoder:

List of all members.


Public Member Functions
	CP_Base64Encoder ()
virtual	~CP_Base64Encoder ()
virtual UInt32	GetEncodedSize (UInt32 inOriginalSize)
virtual bool	Encode (const CP_HandleBlock &inData)
virtual bool	Decode (const CP_HandleBlock &inData)
void	SetID (FourCharCode inIdentifier)
FourCharCode	GetID ()
void	RegisterSignal (const CP_SignalHolder &inSignal)
CP_DataValueSignal *	FindSignal (const CP_String &inSignalName)
UInt32	GetNumberSignals ()
CP_String	GetNthSignalName (UInt32 inSignalIndex)
void	RegisterSlot (const CP_SlotHolder &inSlot)
CP_DataValueSlot	FindSlot (const CP_String &inSlotName)
UInt32	GetNumberSlots ()
CP_String	GetNthSlotName (UInt32 inSlotIndex)
template<class R, class P1, class P2>
CP_CommandHandlerSignal *	Connect (CPLAT::CP_CommandNo cmd, void(R::*handler)(P1, P2), SInt32 mode)
template<class R, class P1, class P2>
void	Connect (CP_Object control, const CPLAT::CP_String &signalName, void(R::handler)(P1, P2))
Getters
CP_HandleBlock *	GetEncodedData ()
CP_String	GetEncodingType ()
Encode
void	SetEncodingType (const CP_String &inEncoding)
Static Public Member Functions
static void	Connect (CP_Object sender, const CP_String &signalName, CP_Object receiver, const CP_String &slotName, const bool reciprocal=false)
static void	Connect (CP_Object sender, CP_Object receiver, const bool reciprocal=false, const CP_String &signalName=kCP_Signal_ValueChanged, const CP_String &slotName=kCP_Slot_SetValue)
Protected Attributes
CP_String	fEncodingType
CP_HandleBlock *	fData
CP_Signals_Array *	fSignals
CP_Slots_Array *	fSlots
FourCharCode	fObjectID
Static Protected Attributes
static char	gBase64Table [] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"
static FourCharCode	fObjectIDCount = 0

Detailed Description

The CP_Base64Encoder is an object of type CP_DataEncoder that encodes / decodes data contained in a CP_HandleBlock object in Base64 encoding. Can be sed with the internet protocol classes to send / receive data.

See also:: CP_DataEncoder, CP_HandleBlock.

Constructor & Destructor Documentation

CP_Base64Encoder::CP_Base64Encoder ( )

Constructor.
See also:
CP_DataEncoder.

CP_Base64Encoder::~CP_Base64Encoder ( ) [virtual]

Desstructor.

Member Function Documentation

UInt32 CP_Base64Encoder::GetEncodedSize ( UInt32 inOriginalSize ) [virtual]

Return the size of our encoded data based on the input data length.
Parameters:

inOriginalSize - the original size of our data.

Implements CP_DataEncoder.

bool CP_Base64Encoder::Encode ( const CP_HandleBlock & inData ) [virtual]

Encode the data contained in inData using base 64 encoding.
Parameters:

inData - CP_HandleBlock containing the data to be encoded. The encoded data is stored in the fData data member for this class, and the original data is untouched.

See also:
CP_HandleBlock.

Implements CP_DataEncoder.

bool CP_Base64Encoder::Decode ( const CP_HandleBlock & inData ) [virtual]

Decode the data contained in inData using base 64 encoding.
Parameters:

inData - CP_HandleBlock containing the data to be decoded. The decoded data is stored in the fData data member for this class, and the original data is untouched.

See also:
CP_HandleBlock.

Implements CP_DataEncoder.

CP_HandleBlock* CP_DataEncoder::GetEncodedData ( ) [inherited]

Return the encoded or decoded data, depending on whether we called Encode or Decode().
See also:
CP_HandleBlock.

CP_String CP_DataEncoder::GetEncodingType ( ) [inherited]

Return the type of encoding being used, this should be a MIME type.
See also:
CP_String.

void CP_DataEncoder::SetEncodingType ( const CP_String & inEncoding ) [inherited]

Set the type of encoding being used, this should be a MIME type of description.
See also:
CP_String.

void CP_Object::SetID ( FourCharCode inIdentifier ) [inherited]

Sets the identifier for this object. If a specific identifier is not set with this function, then a default id is used, which is simply a running count of the number of objects created.

Parameters:

inIdentifier The objects identifier.

Returns:
void

FourCharCode CP_Object::GetID ( ) [inherited]

Returns the objects identifier.

Returns:
FourCharCode The identifier of this object.

void CP_Object::RegisterSignal ( const CP_SignalHolder & inSignal ) [inherited]

Registers the signal / signal name contained in the passed in inSignal object.

Parameters:

inSignal CP_SignalHolder that holds a signal and string identifier.

Returns:
void

CP_DataValueSignal * CP_Object::FindSignal ( const CP_String & inSignalName ) [inherited]

Finds the CP_DataValueSignal object that matches the passed in inSignalName.

Parameters:

inSignalName CP_String containing the identifier of the signal to return.

Returns:
CP_DataValueSignal * Returns a pointer to a CP_DataValueSignal object.

UInt32 CP_Object::GetNumberSignals ( ) [inherited]

Returns the number of signals for this object.

Returns:
UInt32 The number of signals.

CP_String CP_Object::GetNthSignalName ( UInt32 inSignalIndex ) [inherited]

Returns the signal name of the passed in signal index.

Parameters:

inSignalIndex Index of the name of the signal to return.

Returns:
CP_String The name of the nth signal being returned.

void CP_Object::RegisterSlot ( const CP_SlotHolder & inSlot ) [inherited]

Registers the slot / slot name contained in the passed in inSlot object.

Parameters:

inSlot CP_SignalHolder that holds a slot and string identifier.

Returns:
void

CP_DataValueSlot CP_Object::FindSlot ( const CP_String & inSlotName ) [inherited]

Finds the CP_Slot1 object that matches the passed in inSlotName.

Parameters:

inSlotName CP_String containing the identifier of the slot to return.

Returns:
CP_DataValueSlot Returns a pointer to a CP_DataValueSlot object.

UInt32 CP_Object::GetNumberSlots ( ) [inherited]

Returns the number of slots for this object.

Returns:
UInt32 The number of slots.

CP_String CP_Object::GetNthSlotName ( UInt32 inSlotIndex ) [inherited]

Returns the slot name of the passed in signal index.

Parameters:

inSlotIndex Index of the name of the slot to return.

Returns:
CP_String The name of the nth slot being returned.

template<class R, class P1, class P2>

CP_CommandHandlerSignal* CP_Object::Connect ( CPLAT::CP_CommandNo cmd,

void(R::*)(P1, P2) handler,

SInt32 mode

) [inherited]

template<class R, class P1, class P2>

void CP_Object::Connect ( CP_Object * control,

const CPLAT::CP_String & signalName,

void(R::*)(P1, P2) handler

) [inherited]

void CP_Object::Connect ( CP_Object * sender,

const CP_String & signalName,

CP_Object * receiver,

const CP_String & slotName,

const bool reciprocal = false

) [static, inherited]

void CP_Object::Connect ( CP_Object * sender,

CP_Object * receiver,

const bool reciprocal = false,

const CP_String & signalName = kCP_Signal_ValueChanged,

const CP_String & slotName = kCP_Slot_SetValue

) [static, inherited]

Member Data Documentation

char CP_Base64Encoder::gBase64Table = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/" [static, protected]

CP_String CP_DataEncoder::fEncodingType [protected, inherited]

CP_HandleBlock* CP_DataEncoder::fData [protected, inherited]

Describes the type of encoding being used, in MIME format

CP_Signals_Array* CP_Object::fSignals [protected, inherited]

CP_Slots_Array* CP_Object::fSlots [protected, inherited]

List of registered signals for this object.

FourCharCode CP_Object::fObjectID [protected, inherited]

List of registered slots for this object.

CPLAT_Begin_Namespace_CPLAT FourCharCode CP_Object::fObjectIDCount = 0 [static, protected, inherited]

Object identifier.

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

Generated on Tue Sep 20 20:21:33 2005 for CPLAT_MacOS by

1.4.0

CP_Base64Encoder Class Reference

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation