 |
Server API Reference Guide |
Visualization Server Documentation Home |
This class is internally used by Rogue Wave Server to exchange interaction messages between an object server and application components. More...
#include <ilserver/mvmsg.h>
Classes | |
| struct | SvMsg |
| This structure enables you to specify a message identifier, a message level and a message description. More... | |
Public Member Functions | |
Insertion operators | |
These operators insert the item passed as argument to the message and returns this message. | |
| 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<< (const IlsMsgBuffer &) |
| IlsMvMessage & | operator<< (const IlsMvMessage &) |
Extraction operators | |
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>> (char &) |
| Extract a string value from the message. More... | |
| IlsMvMessage & | operator>> (unsigned char &) |
| Extract a string value from the message. More... | |
| IlsMvMessage & | operator>> (short &) |
| Extract a string value from the message. More... | |
| IlsMvMessage & | operator>> (unsigned short &) |
| Extract a string value from the message. More... | |
| IlsMvMessage & | operator>> (int &) |
| Extract a string value from the message. More... | |
| IlsMvMessage & | operator>> (unsigned int &) |
| Extract a string value from the message. More... | |
| IlsMvMessage & | operator>> (long &) |
| Extract a string value from the message. More... | |
| IlsMvMessage & | operator>> (unsigned long &) |
| Extract a string value from the message. More... | |
| IlsMvMessage & | operator>> (float &) |
| Extract a string value from the message. More... | |
| IlsMvMessage & | operator>> (double &) |
| Extract a string value from the message. More... | |
| IlsMvMessage & | operator>> (IlsString &) |
| Extract a string value from the message. More... | |
| IlsMvMessage & | operator>> (char *&) |
| Extract a string value from the message. More... | |
| IlsMvMessage & | operator>> (IlsMsgBuffer &) |
| Extract a string value from the message. More... | |
| IlsMvMessage & | operator>> (IlsMvMessage &) |
| Extract a string value from the message. More... | |
Error handling | |
| IlsBoolean | fail () |
Returns the failure status of the IlsMvMessage. | |
 Public Member Functions inherited from IlsMvUserType | |
| virtual | ~IlsMvUserType () |
| Virtual destructor. | |
| virtual IlsBoolean | asBoolean (IlsBoolean defaultVal=IlsFalse) const |
Called by IlsMvValue::asBoolean() when the instance of IlsMvValue to which it applies contains an object whose type is user-defined. More... | |
| virtual char | asChar (char defaultVal=0) const |
Called by IlsMvValue::asChar() when the object of type IlsMvValue to which it applies contains an object whose type is user-defined. More... | |
| virtual long | asLong (long defaultVal=0) const |
Called by IlsMvValue::asLong() when the object of type IlsMvValue to which it applies contains an object whose type is user-defined. More... | |
| virtual float | asFloat (float defaultVal=0.0) const |
Called by IlsMvValue::asFloat() when the object of type IlsMvValue to which it applies contains an object whose type is user-defined. More... | |
| virtual double | asDouble (double defaultVal=0.0) const |
Called by IlsMvValue::asDouble() when the object of type IlsMvValue to which it applies contains an object whose type is user-defined. More... | |
| virtual IlsString | asString (IlsString defaultVal=(char *) 0) const |
Called by IlsMvValue::asString() when the object of type IlsMvValue to which it applies contains an object whose type is user-defined. More... | |
| virtual IlsMvRef | asObjectRef (IlsMvRef defaultVal=IlsMvRef()) const |
Called by IlsMvValue::asObjectRef() when the object of type IlsMvValue to which it applies contains an object whose type is user-defined. More... | |
| virtual IlsMvUserType * | asValue (IlsMvDataType typeId, IlsMvUserType *defaultVal=0) const |
| Called by Rogue Wave Server when it needs to convert a user type value into another user type. More... | |
| virtual IlsBoolean | operator== (const IlsMvUserType &v) const |
Called by the operator IlsMvValue::operator==() when the object and the argument to which it applies contain user-defined type values. More... | |
| virtual IlsBoolean | operator!= (const IlsMvUserType &v) const |
Called by the operator IlsMvValue::operator!=() when the object and the argument to which it applies contain user-defined type values. More... | |
| virtual IlsBoolean | operator< (const IlsMvUserType &) const |
Called by the operator IlsMvValue::operator<() when the object and the argument to which it applies contain user-defined type values. More... | |
| virtual IlsBoolean | operator> (const IlsMvUserType &) const |
Called by the operator IlsMvValue::operator>() when the object and the argument to which it applies contain user-defined type values. More... | |
| virtual IlsBoolean | operator<= (const IlsMvUserType &) const |
Called by the operator IlsMvValue::operator<=() when the object and the argument to which it applies contain user-defined type values. More... | |
| virtual IlsBoolean | operator>= (const IlsMvUserType &) const |
Called by the operator IlsMvValue::operator>=() when the object and the argument to which it applies contain user-defined type values. More... | |
| virtual IlsBoolean | operator! () const |
Called by the operator IlsMvValue::operator!() when the object and the argument to which it applies contain user-defined type values. More... | |
| virtual IlsLogfile & | print (IlsLogfile &) const |
| Called in trace mode to display a value whose type is user-defined. More... | |
| virtual IlsMvMessage & | ilsEncode (IlsMvMessage &) const =0 |
This pure virtual member function is called to encode a value whose type is user-defined in an instance of IlsMvMessage. More... | |
Static Public Member Functions | |
Message Handling | |
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);
| |
| static SvMsg | AppliInfo (const IlsString &) |
| static SvMsg | AppliWarning (const IlsString &) |
| static SvMsg | AppliError (const IlsString &) |
| Static Public Member Functions inherited from IlsMvUserType | |
| static IlsMvUserType * | IlsDecode (IlsMvMessage &) |
| This static member function is called by Server to extract a user-type value from a message. More... | |
Friends | |
| class | IlsMvComponentItf |
Additional Inherited Members | |
| Protected Member Functions inherited from IlsMvUserType | |
| IlsMvUserType () | |
| The default constructor of the class is protected. | |
This class is internally used by Rogue Wave Server to exchange interaction messages between an object server and application components.
Library: mvserver
and mvcomp
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.
IlsMvUserType, IlsMvProcess. | ILSIMPORT_MVSVR IlsMvMessage & IlsMvMessage::operator>> | ( | char & | v | ) |
Extract a string value from the message.
The string is assigned to the argument passed. It must be deallocated by the user.
| IlsMvMessage& IlsMvMessage::operator>> | ( | char *& | ) |
Extract a string value from the message.
The string is assigned to the argument passed. It must be deallocated by the user.
| ILSIMPORT_MVSVR IlsMvMessage & IlsMvMessage::operator>> | ( | double & | v | ) |
Extract a string value from the message.
The string is assigned to the argument passed. It must be deallocated by the user.
| ILSIMPORT_MVSVR IlsMvMessage & IlsMvMessage::operator>> | ( | float & | v | ) |
Extract a string value from the message.
The string is assigned to the argument passed. It must be deallocated by the user.
| ILSIMPORT_MVSVR IlsMvMessage & IlsMvMessage::operator>> | ( | IlsMsgBuffer & | v | ) |
Extract a string value from the message.
The string is assigned to the argument passed. It must be deallocated by the user.
| ILSIMPORT_MVSVR IlsMvMessage & IlsMvMessage::operator>> | ( | IlsMvMessage & | v | ) |
Extract a string value from the message.
The string is assigned to the argument passed. It must be deallocated by the user.
| IlsMvMessage& IlsMvMessage::operator>> | ( | IlsString & | ) |
Extract a string value from the message.
The string is assigned to the argument passed. It must be deallocated by the user.
| ILSIMPORT_MVSVR IlsMvMessage & IlsMvMessage::operator>> | ( | int & | v | ) |
Extract a string value from the message.
The string is assigned to the argument passed. It must be deallocated by the user.
| ILSIMPORT_MVSVR IlsMvMessage & IlsMvMessage::operator>> | ( | long & | v | ) |
Extract a string value from the message.
The string is assigned to the argument passed. It must be deallocated by the user.
| ILSIMPORT_MVSVR IlsMvMessage & IlsMvMessage::operator>> | ( | short & | v | ) |
Extract a string value from the message.
The string is assigned to the argument passed. It must be deallocated by the user.
| ILSIMPORT_MVSVR IlsMvMessage & IlsMvMessage::operator>> | ( | unsigned char & | v | ) |
Extract a string value from the message.
The string is assigned to the argument passed. It must be deallocated by the user.
| ILSIMPORT_MVSVR IlsMvMessage & IlsMvMessage::operator>> | ( | unsigned int & | v | ) |
Extract a string value from the message.
The string is assigned to the argument passed. It must be deallocated by the user.
| ILSIMPORT_MVSVR IlsMvMessage & IlsMvMessage::operator>> | ( | unsigned long & | v | ) |
Extract a string value from the message.
The string is assigned to the argument passed. It must be deallocated by the user.
| ILSIMPORT_MVSVR IlsMvMessage & IlsMvMessage::operator>> | ( | unsigned short & | v | ) |
Extract a string value from the message.
The string is assigned to the argument passed. It must be deallocated by the user.
|
Copyright 2022 Rogue Wave Software, Inc., a Perforce company. All Rights Reserved. |
|