NVIDIA Iray API — software examples nvidia_logo_transpbg.gif Up
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Call_event_handler Class Reference
Inheritance diagram for Call_event_handler:
mi::base::Interface_implement< mi::rtmp::ICall_event_handler > mi::rtmp::ICall_event_handler mi::base::Interface_declare< 0x9751dc66, 0xb064, 0x4ae8, 0xaa, 0x32, 0x54, 0x89, 0x41, 0x86, 0xcc, 0x1d > mi::base::IInterface

Public Member Functions

 Call_event_handler (mi::neuraylib::IScope *scope)
 
bool handle (mi::rtmp::IConnection *, const char *, const mi::IData *, const mi::IData *user_arguments, mi::IData **)
 Called on a remote call event. More...
 
- Public Member Functions inherited from mi::base::Interface_implement< mi::rtmp::ICall_event_handler >
 Interface_implement (Uint32 initial=1)
 Constructor. More...
 
 Interface_implement (const Interface_implement< mi::rtmp::ICall_event_handler > &other)
 Copy constructor. More...
 
Interface_implement
< mi::rtmp::ICall_event_handler > & 
operator= (const Interface_implement< mi::rtmp::ICall_event_handler > &other)
 Assignment operator. More...
 
virtual Uint32 retain () const
 Increments the reference count. More...
 
virtual Uint32 release () const
 Decrements the reference count. More...
 
virtual const IInterfaceget_interface (const Uuid &interface_id) const
 Acquires a const interface. More...
 
virtual IInterfaceget_interface (const Uuid &interface_id)
 Acquires a mutable interface. More...
 
Uuid get_iid () const
 Returns the interface ID of the most derived interface. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0x9751dc66, 0xb064, 0x4ae8, 0xaa, 0x32, 0x54, 0x89, 0x41, 0x86, 0xcc, 0x1d >
typedef Interface_declare< id1,
id2, id3, id4, id5, id6, id7,
id8, id9, id10, id11,
IInterface
Self
 Own type. More...
 
typedef Uuid_t< id1, id2, id3,
id4, id5, id6, id7, id8, id9,
id10, id11 > 
IID
 Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0x9751dc66, 0xb064, 0x4ae8, 0xaa, 0x32, 0x54, 0x89, 0x41, 0x86, 0xcc, 0x1d >
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 
- Protected Member Functions inherited from mi::base::Interface_implement< mi::rtmp::ICall_event_handler >
Atom32refcount () const
 Get the current refcount. More...
 
virtual ~Interface_implement ()
 
- Static Protected Member Functions inherited from mi::base::Interface_declare< 0x9751dc66, 0xb064, 0x4ae8, 0xaa, 0x32, 0x54, 0x89, 0x41, 0x86, 0xcc, 0x1d >
static const IInterfaceget_interface_static (const IInterface *iinterface, const Uuid &interface_id)
 
static IInterfaceget_interface_static (IInterface *iinterface, const Uuid &interface_id)
 

Detailed Description

Definition at line 226 of file example_rtmp_server.cpp.

Constructor & Destructor Documentation

Call_event_handler::Call_event_handler ( mi::neuraylib::IScope scope)
inline

Definition at line 229 of file example_rtmp_server.cpp.

Member Function Documentation

bool Call_event_handler::handle ( mi::rtmp::IConnection connection,
const char *  procedure_name,
const mi::IData command_arguments,
const mi::IData user_arguments,
mi::IData **  response_arguments 
)
inlinevirtual

Called on a remote call event.

A call event is a form of remote procedure call from the client application to the RTMP server. Call handlers for remote commands are registered together with the name of the remote procedure call. The command and user objects supplied represent the command and user objects sent in the RTMP Call packet. The last argument is the outgoing response object where for example an error description or system statistics can be provided.

Note
The connection parameter is only valid during the call of the handle() method and cannot be stored (even if proper reference counting is used).
Parameters
connectionThe connection on which this call event applies to.
procedure_nameThe name of the procedure call
command_argumentsThe command object from the client.
user_argumentsThe user object from the client.
[out]response_argumentsAn empty object which the handler can use to pass data back to the client in the response.
Returns
true if the call succeeded, false otherwise.

Implements mi::rtmp::ICall_event_handler.

Definition at line 231 of file example_rtmp_server.cpp.


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