All Frameworks Class Hierarchy This Framework Previous Next Indexes
VPMInterfaces Interface ENOVIStream
System.IUnknown
|
+---System.IDispatch
|
+---System.CATBaseUnknown
|
+---ENOVIStream
Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.
interface ENOVIStream
Interface to carry extra information in event model, under a Backbone format.
Role: an ENOVIEvent carries some basic information about the raised event between Publisher and subscribers.
to associate extra information, the ENOVIStream is used .
- See also:
- ENOVIEvent
Method Index
- o
AddArgumentValue(CATUnicodeString&,CORBAAny&)
-
Adds an argument value in the opened stream.
- o
GetArgumentValue(CATUnicodeString&,CORBAAny&,CATUnicodeString&)
- For a given Argument name returns the type and the value of the argument.
- o
GetArguments(CATListOfCATUnicodeString&)
- Gets the Event Data stored in the stream
Role: first get the list of arguments name, then ask for each argument the type and value.
- o
GetCookieSession(CATUnicodeString&)
- Gives the Cookie identifying the session this stream comes from.
- o
GetName(CATUnicodeString&)
- Gives the name of the stream
- o
GetType(CATUnicodeString&)
- Gives the type of stream
Methods
o AddArgumentValue
-
Adds an argument value in the opened stream.
This argument must have been declared in the
Datastream definition in the XML event file.
- Parameters:
-
- iArgument
- the argument name
- oArgValue
- the value of argument
o GetArgumentValue
-
For a given Argument name returns the type and the value of the argument.
- Parameters:
-
- iArgument
- the argument name
- oArgValue
- the value of argument
- oArgType
- type of argument
o GetArguments
-
Gets the Event Data stored in the stream
Role: first get the list of arguments name, then ask for each argument the type and value.
- Parameters:
-
- oAssociatedArgs
- the list of arguments name.
o GetCookieSession
-
Gives the Cookie identifying the session this stream comes from.
- Parameters:
-
- oCookie
- the session identifier
o GetName
-
Gives the name of the stream
- Parameters:
-
- oName
- Name of Stream
o GetType
-
Gives the type of stream
- Parameters:
-
- oType
- the type of stream :
. ClientData : filled by the subscribers
. EventData : filled by the publisher
This object is included in the file: ENOVIStream.h
If needed, your Imakefile.mk should include the module: GUIDVPMInterfaces