FRAMES NO FRAMES | |||||||
| |||||||
SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION | DETAIL: IMPORT | CONSTANT | MEMBER | ACTION |
Member summary | |
---|---|
action<string, string> | connect
Connect this Session Handler to the Session identified by the supplied session and transport name using the currently set connected callback (which may be the default supplied by the handler). |
action<string, string, action<com.apama.session.SessionHandler>> | connectCb
Connect this Session Handler to the Session identified by the supplied session and transport name using the supplied callback. |
action<> | disconnect
Disconnect this Session Handler from the current session it is connected to. It is an error to attempt a disconnect before a successful connect. |
action<action<com.apama.session.SessionHandler>> | disconnectCb
Disconnect this Session Handler from the current session it is connected to and call the user back on the supplied callback when successfully disconnected. It is an error to attempt a disconnect before a successful connect. |
action<action<com.apama.session.SessionHandler>> returns integer | addConnectedCallback
Add this callback to the set called when the Session is connected. |
action<integer> | removeConnectedCallback
Remove a Connected Callback identified by the result of "addConnectedCallback". |
action<> | clearConnectedCallbacks
Clear any currently set connected callbacks. |
action<action<com.apama.session.SessionHandler, com.apama.utils.Error>> returns integer | addErrorCallback
Add this Error callback to the set called on an error. |
action<integer> | removeErrorCallback
Remove an Error Callback identified by the result of "addErrorCallback". |
action<> | clearErrorCallbacks
Clear any currently set error callbacks. |
action<com.apama.session.SessionHandler, com.apama.utils.Error> | defaultErrorCallback
Call the default Error callback as supplied by the Handler (which logs the error at ERROR level). You may call this from an overridden Error callback (to get the log message) but it is not required. |
action<com.apama.utils.Params> | setParams
Set the Parameters in this handler to a copy of the supplied parameters, to be used in subsequent subscriptions. |
action<> returns com.apama.utils.Params | getParams
Get a copy of the current parameters of this Handler. |
action<> returns com.apama.session.SessionInfo | getSessionInfo
Get the Session Info event associated with the session this Handler is connected to. |
action<> returns boolean | isConnected
Returns true if the Handler is connected. |
Member detail |
---|
action<action<com.apama.session.SessionHandler>> returns integer addConnectedCallbackAdd this callback to the set called when the Session is connected.
action<action<com.apama.session.SessionHandler, com.apama.utils.Error>> returns integer addErrorCallbackAdd this Error callback to the set called on an error.
action<> clearConnectedCallbacksClear any currently set connected callbacks.
action<> clearErrorCallbacksClear any currently set error callbacks.
action<string, string> connectConnect this Session Handler to the Session identified by the supplied session and transport name using the currently set connected callback (which may be the default supplied by the handler).
action<string, string, action<com.apama.session.SessionHandler>> connectCbConnect this Session Handler to the Session identified by the supplied session and transport name using the supplied callback.
action<com.apama.session.SessionHandler, com.apama.utils.Error> defaultErrorCallbackCall the default Error callback as supplied by the Handler (which logs the error at ERROR level). You may call this from an overridden Error callback (to get the log message) but it is not required.
action<> disconnectDisconnect this Session Handler from the current session it is connected to. It is an error to attempt a disconnect before a successful connect.
action<action<com.apama.session.SessionHandler>> disconnectCbDisconnect this Session Handler from the current session it is connected to and call the user back on the supplied callback when successfully disconnected. It is an error to attempt a disconnect before a successful connect.
action<> returns com.apama.utils.Params getParamsGet a copy of the current parameters of this Handler.
action<> returns com.apama.session.SessionInfo getSessionInfoGet the Session Info event associated with the session this Handler is connected to.
action<> returns boolean isConnectedReturns true if the Handler is connected.
action<integer> removeConnectedCallbackRemove a Connected Callback identified by the result of "addConnectedCallback".
action<integer> removeErrorCallbackRemove an Error Callback identified by the result of "addErrorCallback".
action<com.apama.utils.Params> setParamsSet the Parameters in this handler to a copy of the supplied parameters, to be used in subsequent subscriptions.
FRAMES NO FRAMES | |||||||
| |||||||
SUMMARY: IMPORT | CONSTANT | MEMBER | ACTION | DETAIL: IMPORT | CONSTANT | MEMBER | ACTION |