IlsMvMessage
Category
Dynamic view-related class (component and server)
Inheritance Path
IlsMvMessage
Description
This class is internally used by Rogue Wave Server to exchange interaction messages between an object server and application components. It is usually transparent to the user. However, when a subclass of
IlsMvUserType is declared, you have to implement the function that lets you insert this type into an
IlsMvMessage and extract it from an
IlsMvMessage.
Libraries
Synopsis
class IlsMvMessage{
public:
typedef unsigned short int Identifier;
IlsMvMessage& operator << (char);
IlsMvMessage& operator << (unsigned char);
IlsMvMessage& operator << (const char*);
IlsMvMessage& operator << (const IlsString&);
IlsMvMessage& operator << (short);
IlsMvMessage& operator << (unsigned short);
IlsMvMessage& operator << (int);
IlsMvMessage& operator << (unsigned int);
IlsMvMessage& operator << (long);
IlsMvMessage& operator << (unsigned long);
IlsMvMessage& operator << (float);
IlsMvMessage& operator << (double);
IlsMvMessage& operator >> (char&);
IlsMvMessage& operator >> (unsigned char&);
IlsMvMessage& operator >> (short&);
IlsMvMessage& operator >> (unsigned short&);
IlsMvMessage& operator >> (int&);
IlsMvMessage& operator >> (unsigned int&);
IlsMvMessage& operator >> (long&);
IlsMvMessage& operator >> (unsigned long&);
IlsMvMessage& operator >> (float&);
IlsMvMessage& operator >> (double&);
IlsMvMessage& operator >> (IlsString*&);
IlsMvMessage& operator >> (char*&);
static SvMsg AppliInfo(const IlsString& msg);
static SvMsg AppliWarning(const IlsString& msg);
static SvMsg AppliError(const IlsString& msg);
};
Operators
Insertion Operators
IlsMvMessage& operator << (char);
IlsMvMessage& operator << (unsigned char);
IlsMvMessage& operator << (const char*);
IlsMvMessage& operator << (const IlsString&);
IlsMvMessage& operator << (short);
IlsMvMessage& operator << (unsigned short);
IlsMvMessage& operator << (int);
IlsMvMessage& operator << (unsigned int);
IlsMvMessage& operator << (long);
IlsMvMessage& operator << (unsigned long);
IlsMvMessage& operator << (float);
IlsMvMessage& operator << (double);
These operators insert the item passed as argument to the message and returns this message.
Extraction Operators
IlsMvMessage& operator >> (char&);
IlsMvMessage& operator >> (unsigned char&);
IlsMvMessage& operator >> (short&);
IlsMvMessage& operator >> (unsigned short&);
IlsMvMessage& operator >> (int&);
IlsMvMessage& operator >> (unsigned int&);
IlsMvMessage& operator >> (long&);
IlsMvMessage& operator >> (unsigned long&);
IlsMvMessage& operator >> (float&);
IlsMvMessage& operator >> (double&);
These operators extract from the message a value whose type is given by their argument. The value is then assigned to this argument. The message is returned.
IlsMvMessage& operator >> (IlsString*&);
IlsMvMessage& operator >> (char*&);
These operators extract a string value from the message. The string is assigned to the argument passed. When using the second operator, the string must be deallocated by the user.
Error Handling
IlsBoolean fail();
This member function returns the failure status of the IlsMvMessage.
IlsMvMessage& resetFail();
This member function resets the failure status of the IlsMvMessage to IlsFalse.
IlsMvMessage& setFail();
This member function sets the failure status of the IlsMvMessage to IlsTrue. It is called by the extraction operators when an error occurs. It should be invoked by user data type decoding functions when an error is detected.
Message Handling
[static] SvMsg AppliInfo(const IlsString& msg);
[static] SvMsg AppliWarning(const IlsString& msg);
[static] SvMsg AppliError(const IlsString& msg);
These are “shortcut” functions, respectively equivalent to writing the following code :
IlsMvMessage::SvMsg(IlsMvMessage::AppliInfoId,
IlsMvMessage::SvMsg::MvInfo,msg);
IlsMvMessage::SvMsg(IlsMvMessage::AppliWarnId,
IlsMvMessage::SvMsg::MvWarning,msg);
IlsMvMessage::SvMsg(IlsMvMessage::AppliErrorId,
IlsMvMessage::SvMsg::MvError,msg);
See Also
Version 5.8
Copyright © 2014, Rogue Wave Software, Inc. All Rights Reserved.