/**
 * Copyright (C) 2009-2013 FoundationDB, LLC
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

package com.foundationdb.server.service.monitor;

import java.util.List;

public interface SessionMonitor {
    /** The id of the session being monitored. */
    int getSessionId();

    /** The id of the session that called this one or -1 if none. */
    int getCallerSessionId();

    /** What kind of server is this a session for? */
    String getServerType();

    /** The remote IP address of a network connection or <code>null</code>. */
    String getRemoteAddress();

    /** The system time at which this session started. */
    long getStartTimeMillis();
    
    /** The number of queries executed. */
    long getStatementCount();

    /** Get number of statements executes of a given type */
    long getCount(StatementTypes type);
    
    /** Count an statement execution */
    void countEvent(StatementTypes type);
    
    /** The SQL of the current / last statement. */
    String getCurrentStatement();    

    /** The time at which the current statement began executing or <code>-1</code>. */
    long getCurrentStatementStartTimeMillis();

    /** The time at which the current statement completed or <code>-1</code>. */
    long getCurrentStatementEndTimeMillis();

    /** The time for which current statement ran. */
    long getCurrentStatementDurationMillis();

    /** The prepared statement name if current statement was prepared. */
    String getCurrentStatementPreparedName();

    /** The number of rows returned / affected by the last statement
     * or <code>-1</code> if unknown, not applicable or in
     * progress. 
     */
    int getRowsProcessed();

    /** The current stage of the session. */
    MonitorStage getCurrentStage();
    
    /** The time in nanoseconds last spent in the given stage. */
    long getLastTimeStageNanos(MonitorStage stage);

    /** The total time in nanoseconds spent in the given stage. */
    long getTotalTimeStageNanos(MonitorStage stage);

    /** Get total time in nanoseconds not spent idle. */
    long getNonIdleTimeNanos();

    /** Get any open cursors. */
    List<CursorMonitor> getCursors();

    /** Get any prepared statements. */
    List<PreparedStatementMonitor> getPreparedStatements();
    
    /** Get the user monitor for this session */
    UserMonitor getUserMonitor();

    public void addSessionEventListener(SessionEventListener listener);
    public void removeSessionEventListener (SessionEventListener listener);
    
    
    public enum StatementTypes {
        STATEMENT,
        FAILED ,
        FROM_CACHE,
        LOGGED,
        
        CALL_STMT,
        DDL_STMT,
        DML_STMT,
        SELECT,
        OTHER_STMT;
    }
}