Iray SDK API nvidia_logo_transpbg.gif Up
mi::rtmp::IServer Class Referenceabstract

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

#include <rtmp.h>

Inheritance diagram for mi::rtmp::IServer:

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...
 
- Public Member Functions inherited from mi::base::IInterface
virtual Uint32 retain () const =0
 Increments the reference count. More...
 
virtual Uint32 release () const =0
 Decrements the reference count. More...
 
virtual const IInterfaceget_interface (const Uuid &interface_id) const =0
 Acquires a const interface from another. More...
 
template<class T>
const T * get_interface () const
 Acquires a const interface from another. More...
 
virtual IInterfaceget_interface (const Uuid &interface_id)=0
 Acquires a mutable interface from another. More...
 
template<class T>
T * get_interface ()
 Acquires a mutable interface from another. More...
 
virtual Uuid get_iid () const =0
 Returns the interface ID of the most derived interface. More...
 

Additional Inherited Members

- Public Types inherited from mi::base::Interface_declare< 0xe0a7301d, ... >
typedef Interface_declare< id1, ... > Self
 Own type. More...
 
typedef Uuid_t< id1, ... > IID
 Declares the interface ID (IID) of this interface. More...
 
- Public Types inherited from mi::base::IInterface
typedef Uuid_t<0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0> IID
 Declares the interface ID (IID) of this interface. More...
 
- Static Public Member Functions inherited from mi::base::Interface_declare< 0xe0a7301d, ... >
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
 
- Static Public Member Functions inherited from mi::base::IInterface
static bool compare_iid (const Uuid &iid)
 Compares the interface ID iid against the interface ID of this interface. More...
 

Detailed Description

The server builds a framework for the handlers.

Member Function Documentation

 get_listen_address()

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

Returns the listen address of the server.

 install()

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
handlerThe handler to be installed.

 remove()

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

Removes a previously installed connect event handler from the server.

Parameters
handlerThe handler to be removed.

 shutdown()

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()

 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_addressThe address to listen on
Returns
0, if the server could be started, or -1 in case of errors
See also
shutdown()