This class represents a Bridge application.
More...
#include <ibridge_server.h>
|
| typedef Interface_declare< id1, ... > | Self |
| | Own type. More...
|
| |
| typedef Uuid_t< id1, ... > | IID |
| | Declares the interface ID (IID) of this interface. More...
|
| |
| 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 bool | compare_iid (const Uuid &iid) |
| | Compares the interface ID iid against the interface ID of this interface and of its ancestors. More...
|
| |
| static bool | compare_iid (const Uuid &iid) |
| | Compares the interface ID iid against the interface ID of this interface. More...
|
| |
This class represents a Bridge application.
When a client opens a session to a Bridge server it also specifies the application it wants to connect to. The features of the application are defined by the Bridge jobs registered with the application.
- See also
- mi::bridge::IBridge_server::create_application()
◆ close()
| virtual Sint32 mi::bridge::IApplication::close |
( |
| ) |
|
|
pure virtual |
Closes the application and any open sessions.
- Returns
- 0: Success.
- -1: The application is already closed.
- <= -2: Unspecified error.
◆ get_disk_cache()
| virtual const char * mi::bridge::IApplication::get_disk_cache |
( |
| ) |
const |
|
pure virtual |
◆ get_log_forwarding_limit()
Returns the maximum verbosity of log messages that will be forwarded to the client.
- See also
- set_log_forwarding_limit()
- Returns
- The current log forwarding limit
◆ get_session_handler()
Returns the current session handler, or NULL if no session handler has been set.
◆ is_open()
| virtual bool mi::bridge::IApplication::is_open |
( |
| ) |
|
|
pure virtual |
Indicates whether the application is open, i.e., whether it accepts client sessions.
◆ open()
| virtual Sint32 mi::bridge::IApplication::open |
( |
| ) |
|
|
pure virtual |
Opens the application so that clients can open sessions to it.
- Returns
- 0: Success
- -1: Mandatory configuration is incomplete (
- See also
- set_disk_cache()).
- -2: The application is already open.
- <= -3: Unspecified error.
◆ register_job() [1/2]
template<class T>
| Sint32 mi::bridge::IApplication::register_job |
( |
| ) |
|
|
inline |
Registers a Bridge job with the application.
All jobs to be executed via the Bridge need to be registered with the corresponding application.
This templated member function is a wrapper of the non-template variant for the user's convenience. It uses the default class factory mi::neuraylib::User_class_factory specialized for T.
- See also
- unregister_job()
- Returns
0 in case of success, <0 in case of failure.
◆ register_job() [2/2]
Registers a Bridge job with the application.
All jobs to be executed via the Bridge need to be registered with the corresponding application.
- See also
- unregister_job()
- Parameters
-
| job_class_id | The class ID of the job. You can simply pass IID() of your class derived from mi::bridge::IServer_job. |
| factory | The factory method of the job. |
- Returns
0 in case of success, <0 in case of failure.
◆ set_disk_cache()
| virtual Sint32 mi::bridge::IApplication::set_disk_cache |
( |
const char * |
location | ) |
|
|
pure virtual |
Sets the disk cache to use.
- Note
- The disk cache must be set before the application can be opened for client sessions. The disk cache can not be changed after it has been successfully set.
- See also
- get_disk_cache(), mi::neuraylib::ICache_manager_factory
- Parameters
-
| location | The location of the disk cache. This can be either a directory on the local machine (prefix "path:") or the address of some cache manager (prefix "address:"). |
- Returns
- 0: Success.
- -1: Invalid argument (
disk_cache is NULL or has an incorrect format).
- -2: No disk cache found at the specified location.
- -3: The disk cache was already set.
- <= -4: Unspecified error.
◆ set_log_forwarding_limit()
Sets the maximum verbosity of log messages that will be forwarded to the client.
Note that the log level that will be forwarded is requested by the client, and this setting will only override the client request in case the server needs to restrict logging further, for instance because of security considerations. So if the client requests that info level messages and more severe will be forwarded and the server sets the limit to warning severity, then only warning log messages will be forwarded.
Defaults to mi::base::details::MESSAGE_SEVERITY_DEBUG which will allow the client to request forwarding of all log messages. Set to mi::base::details::MESSAGE_SEVERITY_FATAL to turn of log forwarding.
- See also
- get_log_forwarding_limit()
- Parameters
-
| limit | The log message limit to set. |
◆ set_session_handler()
Sets the session handler that will be called when clients connect.
The session handler will be called as part of the handshake between client and server to decide whether to accept or to reject the client, e.g., based on a security token supplied by the client. The server will always accept clients if no session handler is set (default behavior). The session handler can also be used to keep track of which sessions are connected to the application and their state by adding an mi::bridge::IServer_session_state_callback to the session.
- Parameters
-
| handler | The handler to be set or NULL to remove the current handler. |
◆ unregister_job() [1/2]
template<class T>
| Sint32 mi::bridge::IApplication::unregister_job |
( |
| ) |
|
|
inline |
Unregisters a Bridge job with the application.
This templated member function is a wrapper of the non-template variant for the user's convenience.
- See also
- register_job()
- Returns
0 in case of success, <0 in case of failure.
◆ unregister_job() [2/2]
| virtual Sint32 mi::bridge::IApplication::unregister_job |
( |
const base::Uuid & |
job_class_id | ) |
|
|
pure virtual |
Unregisters a Bridge job with the application.
- See also
- register_job()
- Parameters
-
| job_class_id | The class id of the job. |
- Returns
0 in case of success, <0 in case of failure.
Public Member Functions inherited from mi::base::IInterface