Main Page Class Hierarchy Compound List Compound Members DefaultTextMessage Class Reference
A default implementation for a text message. More...
Inheritance diagram for DefaultTextMessage:
List of all members.
Public Methods
DefaultTextMessage (void) Default constructor for the default text message. DefaultTextMessage (const std::string &text) Additional constructor for the default text message. DefaultTextMessage (const char *text) Additional constructor for the default text message. void onSerialize (OutputStreamPtr &stream) throw (SoamException) This method will be called during serialization of the message. void onDeserialize (InputStreamPtr &stream) throw (SoamException) This method will be called during de-serialization of the message. void setText (const std::string &text) This method allows the developer to set the text within the message. void setText (const char *text) This method allows the developer to set the internal byteArray within the message. void getText (std::string &text) const This method allows the developer to get the internal text from the message. const char * getText () const This method allows the developer to retrieve the text from the message. operator const char * () const operator to return a character array directly from the text message. Detailed Description
A default implementation for a text message.This represents a default implementation for developers requiring a convenient way to submit text messages without creating their own implementation. This object is not thread safe, therefore the developer is responsible for any synchronization required. This message can be used in applications that have a "cross-platform" implementation. (i.e. client and service may be implemented in different supported languages)
- See also:
- Message
Constructor & Destructor Documentation
DefaultTextMessage ( void )
Default constructor for the default text message.
DefaultTextMessage ( const std::string & text )
Additional constructor for the default text message.
the parameters exposed are exactly the same exposed by setText().
- See also:
- DefaultTextMessage::setText
DefaultTextMessage ( const char * text )
Additional constructor for the default text message.
the parameters exposed are exactly the same exposed by setText().
- See also:
- DefaultTextMessage::setText
Member Function Documentation
void onSerialize ( OutputStreamPtr & stream ) throw (SoamException) [virtual]
This method will be called during serialization of the message.
- Parameters:
stream [IN] - the stream to which the object is being serialized.
- See also:
- OutputStream
Implements Message.
void onDeserialize ( InputStreamPtr & stream ) throw (SoamException) [virtual]
This method will be called during de-serialization of the message.
- Parameters:
stream [IN] - the stream from which the object is being de-serialized.
- See also:
- InputStream
Implements Message.
void setText ( const std::string & text )
This method allows the developer to set the text within the message.
- Parameters:
text [IN] - a reference to a std::string object containing the text to be associated with the message. If a null value is passed for this parameter all other parameters will be ignored and a text of length zero will be assumed.
void setText ( const char * text )
This method allows the developer to set the internal byteArray within the message.
- Parameters:
text [IN] - a pointer to a character array containing the text to be associated with the message. If a null value is passed for this parameter all other parameters will be ignored and a text of length zero will be assumed.
void getText ( std::string & text ) const
This method allows the developer to get the internal text from the message.
- Parameters:
text [OUT] - the variable to accept the text being returned.
const char* getText ( ) const
This method allows the developer to retrieve the text from the message.
- Returns:
- the internal text.
operator const char * ( ) const
operator to return a character array directly from the text message.
Date Modified: 3 Nov 2008
Platform Support: support@platform.com
Platform Information Development: doc@platform.com
Platform Computing. Accelerating Intelligence(TM).
Copyright © 2001-2008 Platform Computing Corporation. All rights reserved.