IceFIX::BridgeAdmin
Overview
interface BridgeAdmin
Used by administrators to manage the bridge.
Operation Index
activate — Activate the bridge.
deactivate — Deactivate the bridge.
clean — Remove any routing records older than timeout seconds.
dbstat — Return some statistics about the bridge database.
getStatus — Get the bridge status.
unregister — Unregister the given client id.
register — Register a client and return a new id.
registerWithId — Register a client with the given id.
getClients — Get list of clients.
Operations
void activate()
Activate the bridge. Once this has been called the bridge will start trying to login to the trading partner.
void deactivate()
Deactivate the bridge.
long clean(long timeout, bool commit)
Remove any routing records older than timeout seconds.
Parameters
timeout — The timeout in seconds.
commit — true if the records should be erased, false otherwise.
Return Value
The number of records erased, or if commit is false the number of records that would be erased.
string dbstat()
Return some statistics about the bridge database.
Return Value
the statistics.
IceFIX::BridgeStatus getStatus()
Get the bridge status.
Return Value
the status.
void unregister(string id, bool force) throws IceFIX::RegistrationException
Unregister the given client id. If the client is active, or the client has associated unrouted messages and force is false, then unregister fails.
Parameters
id — The id of the client to unregister.
force — If true erase the client even if there are queued messages, or the client is connected.
Exceptions
IceFIX::RegistrationException — if the client cannot unregister.
string register(IceFIX::QoS clientQoS) throws IceFIX::RegistrationException
Register a client and return a new id.
Parameters
clientQoS — The requested quality of service.
Return Value
The new client id.
Exceptions
IceFIX::RegistrationException — if the client cannot register.
void registerWithId(string id, IceFIX::QoS clientQoS) throws IceFIX::RegistrationException
Register a client with the given id.
Parameters
id — The requested client id.
clientQoS — The requested quality of service.
Exceptions
IceFIX::RegistrationException — if the client cannot register.
IceFIX::ClientInfoSeq getClients()
Get list of clients.
Return Value
A sequence of clients.
