#include <gridclientfactory.hpp>
List of all members.
Detailed Description
Factory implementation.
Member Function Documentation
Starts a client with given configuration. The client will be assigned a randomly generated UUID which can be obtained by GridClient#id() method.
- Parameters:
-
| cfg | Client configuration. |
- Returns:
- The client instance.
- Exceptions:
-
Starts a client with given configuration. Starting client will be assigned a randomly generated UUID which can be obtained by GridClient#id() method.
- Parameters:
-
| cfg | Client configuration. |
- Returns:
- Started client.
- Exceptions:
-
| static void GridClientFactory::stop |
( |
const GridClientUuid & |
clientId, |
|
|
bool |
wait = true | |
|
) |
| | [static] |
Stops particular client.
- Parameters:
-
| clientId | Client identifier to close. |
| wait | If true then client will wait to finish all ongoing requests before closing (however, no new requests will be accepted). If false, client will be closed immediately and all ongoing requests will be failed. |
| static void GridClientFactory::stopAll |
( |
bool |
wait = true |
) |
[static] |
Stops all currently open clients.
- Parameters:
-
| wait | If true then each client will wait to finish all ongoing requests before closing (however, no new requests will be accepted). If false, clients will be closed immediately and all ongoing requests will be failed. |
The documentation for this class was generated from the following files: