Search:

As defined in xcapi.h

Description:

Migrates an existing session to a different Exegy appliance, or allows the client to log in to the same appliance with new credentials. The function terminates the previously established connection with the appliance (represented by the session instance passed in as a parameter to the call) then attempts a new connection with the appliance(s) at the IP address(es) specified in the server_address parameter.

Note that if a new session cannot be established (after trying all submitted IP addresses), the function returns with an error. IT IS POSSIBLE TO LEAVE YOUR SESSION IN A DISCONNECTED STATE WITH THIS FUNCTION. Each server address in the supplied list will be tried once: if all of them fail, xcMigrateSession() will return with an error code. xcMigrateSession() will then have to be called again (perhaps with a different server_address parameter) to get the session back to a connected state.

Note that this function returns immediately, whether a new session is established or not. The callback function associated with the original session is called once when the old connection is terminated, and again if a new connection is established.

If the session, userid or password parameter values are supplied as NULL, no change is made to the currently active session, and the function returns XINVAL.

Restrictions:

• May not be called from within a callback function.
• Belongs to the Mutually Exclusive function set.

Parameters:

• session [IN] Handle to the session object for the session being migrated.
• server_address [IN] The IP address and (optional) port number of the Exegy appliance to be connected to. Accepts a comma-delimited list of IP addresses or "ip:port" pairs (or a single IP address or single ip:port pair). The port number need not be specified if the default port (4001) is to be used. If a list is submitted, each address in the list is tried once. For InfiniBand connections, "ib::" must be prepended to the IP address of the new appliance to be connected to. If a list of IP addresses is passed in (and InfiniBand connections are being used) each server address in the list must be prepended with "ib::". Note that if this parameter is set to an empty string, the list in the configuration file is used. If set to NULL, the previously-active ip:port list is used, with the next appliance in the list tried first (just as if the connection had been terminated by a connectivity problem or by the appliance itself).
• userid [IN] The userid for login to the Exegy Ticker Plant.
• password [IN] The password for login to Exegy Ticker Plant.

Returns:

An xerr type indicating the status of the creation operation.

Common error codes:

XSUCCESS Connection and login to the Exegy appliance were successful.
XINVAL Invalid parameter.
XCONNREFUSED Connection refused.
XCONNRESET Connection reset by peer.
XADDR Connection failed due to bad address.
XSOCKET Unable to connect to specified socket.
XLOGINFAILED Connection refused due to incorrect login credentials.
XPROTO Connection failed because client and appliance could not negotiate a connection.
XTIMEOUT Active connection timed out.
XTIME Connection request timed out waiting for server response.
XVERSION Connection refused due to version mismatch (between Exegy appliance and XC API).
XBADHANDLE Invalid handle.