NVIDIA Iray API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
mi::rtmp::IServer Class Referenceabstract

The server builds a framework for the handlers. More...

Inheritance diagram for mi::rtmp::IServer:
Inheritance graph
[legend]

Public Member Functions

virtual Sint32  start (const char *listen_address)=0
  Starts the server listening on the given address. More...
 
virtual void  shutdown ()=0
  Shuts down a server that has been previously started. More...
 
virtual void  install (IConnect_event_handler *handler)=0
  Adds a new connect event handler to the server. More...
 
virtual void  remove (IConnect_event_handler *handler)=0
  Removes a previously installed connect event handler from the server. More...
 
virtual const char *  get_listen_address () const =0
  Returns the listen address of the server. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0xe0a7301d, 0xb555, 0x4fc6, 0xb5, 0x1d, 0x26, 0x1c, 0xbe, 0x73, 0xea, 0x47 >
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< 0xe0a7301d, 0xb555, 0x4fc6, 0xb5, 0x1d, 0x26, 0x1c, 0xbe, 0x73, 0xea, 0x47 >
static bool  compare_iid (const Uuid &iid)
  Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 

Detailed Description

The server builds a framework for the handlers.

Member Function Documentation

virtual const char* mi::rtmp::IServer::get_listen_address ( ) const
pure virtual

Returns the listen address of the server.

virtual void mi::rtmp::IServer::install ( IConnect_event_handler handler)
pure virtual

Adds a new connect event handler to the server.

The connection handler will be called upon new connections and when connections are closed.

Parameters
handler The handler to be installed.
virtual void mi::rtmp::IServer::remove ( IConnect_event_handler handler)
pure virtual

Removes a previously installed connect event handler from the server.

Parameters
handler The handler to be removed.
virtual void mi::rtmp::IServer::shutdown ( )
pure virtual

Shuts down a server that has been previously started.

The server will stop accepting new requests and shut down as fast as possible. However, requests currently being handled will be served until they are done.

See Also
start()
virtual Sint32 mi::rtmp::IServer::start ( const char *  listen_address)
pure virtual

Starts the server listening on the given address.

The server will run within a separate thread; all requests will be handled in their own threads as well.

Parameters
listen_address The address to listen on
Returns
0, if the server could be started, or -1 in case of errors
See Also
shutdown()