IO2GSessionStatus

The interface provides method signatures to process notifications about session status changes and login failures.

The interface must be implemented by the application in order to process the status change of the session object.

If a login failed, the status changes to Disconnected and the server returns an error message explaining why the login has failed. If you want to capture what has gone wrong, use the onLoginFailed method of the interface.

If a login was successful, the session status changes to Connected. If you want to capture and process every status change of the session object, use the onSessionStatusChanged method of the interface. For a complete list of the session statuses, please see O2GSessionStatusCode. For a detailed explanation of the session statuses, refer to the Session Statuses section.

If you want to use the methods of the IO2GSessionStatus interface, you must create a class that implements the interface. For example,
public class SessionStatusListener: IO2GSessionStatus { }

An instance of the class implementing the IO2GSessionStatus interface must be subscribed to the session object before calling the O2GSession.login method. It is accomplished by calling the O2GSession.subscribeSessionStatus method. For example,

mSession = O2GTransport.createSession();

SessionStatusListener statusListener = new SessionStatusListener(mSession, mDBName, mPin);

mSession.subscribeSessionStatus(statusListener);

mSession.logout();

mSession.unsubscribeSessionStatus(statusListener);

mSession.dispose();

Process notifications about session status changes and a login failure [hide]

using fxcore2;
 
namespace SessionListener
{
    public class SessionStatusListener: IO2GSessionStatus
    {
 
        // Connection , session and status variables
        private bool mConnected = false;
        private bool mDisconnected = false;
        private bool mError = false;
        private String mDBName = "";
        private String mPin = "";
        private O2GSession mSession = null;
        private O2GSessionStatusCode mStatus;
 
 
        /// <summary>
        /// Constructor
        /// </summary>
        /// <param name="session"></param>
        /// <param name="dbName"></param>
        /// <param name="pin"></param>
        public SessionStatusListener(O2GSession session, String dbName, String pin)
        {
            mSession = session;
            mDBName = dbName;
            mPin = pin;
        }
 
        /// <summary>
        /// Shows if session is connected
        /// </summary>
        /// <returns></returns>
        public  bool isConnected()
        {
            return mConnected;
        }
 
        /// <summary>
        /// Shows if session is disconnected
        /// </summary>
        /// <returns></returns>
        public  bool isDisconnected()
        {
            return mDisconnected;
        }
 
        /// <summary>
        /// Shows if there was an error during the logn process
        /// </summary>
        /// <returns></returns>
        public  bool hasError()
        {
            return mError;
        }
 
        /// <summary>
        /// Returns current session status
        /// </summary>
        /// <returns></returns>
        public  O2GSessionStatusCode getStatus()
        {
            return mStatus;
        }
 
        /// <summary>
        /// Implementation of IO2GSessionStatus interface public method onSessionStatusChanged
        /// </summary>
        /// <param name="status"></param>
        public  void onSessionStatusChanged(O2GSessionStatusCode status)
        {
            mStatus = status;
            Console.WriteLine("Status: " + mStatus.ToString());
            if (mStatus == O2GSessionStatusCode.Connected)
            {
                mConnected = true;
            }
            else
            {
                mConnected = false;
            }
            if (status == O2GSessionStatusCode.Disconnected)
            {
                mDisconnected = true;
            }
            else
            {
                mDisconnected = false;
            }
            if (mStatus == O2GSessionStatusCode.TradingSessionRequested)
            {
                O2GSessionDescriptorCollection descs = mSession.getTradingSessionDescriptors();
                Console.WriteLine("\nSession descriptors");
                Console.WriteLine("id, name, description, requires pin");
                foreach(O2GSessionDescriptor desc in descs)
                {
                    Console.WriteLine(desc.Id + " " + desc.Name + " " + desc.Description + " " + desc.RequiresPin);
                }
                if (mDBName.Equals(""))
                {
                    Console.WriteLine("Argument for database is missing");
                }
                else
                {
                    mSession.setTradingSession(mDBName, mPin);
                }
            }
        }
 
        /// <summary>
        /// Implementation of IO2GSessionStatus interface public method onLoginFailed
        /// </summary>
        /// <param name="error"></param>
        public  void onLoginFailed(String error)
        {
            Console.WriteLine("Login error: " + error);
            mError = true;
        }
    }
}

Processing a login failure [hide]

     // Create a session, subscribe to session listener, login
     mSession = O2GTransport.createSession();
     SessionStatusListener statusListener = new SessionStatusListener(mSession, mDBName, mPin);
     mSession.subscribeSessionStatus(statusListener);
     mSession.login(mUserID, mPassword, mURL, mConnection);
     while (!statusListener.isConnected() && !statusListener.hasError()) {
          Thread.Sleep(50);
     }
 
    // Implementation of IO2GSessionStatus interface public method onLoginFailed
    public void onLoginFailed(String error) {
        Console.WriteLine("Login error: " + error);
        mError = true;
    }

Public Methods
onLoginFailed	Processes a notification about a login failure.
onSessionStatusChanged	Processes notifications about session status changes.