/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.zookeeper_voltpatches.server;

import java.io.IOException;
import java.net.InetSocketAddress;
import java.util.ArrayList;
import java.util.Date;

import org.apache.jute_voltpatches.Record;
import org.apache.zookeeper_voltpatches.WatchedEvent;
import org.apache.zookeeper_voltpatches.Watcher;
import org.apache.zookeeper_voltpatches.data.Id;
import org.apache.zookeeper_voltpatches.proto.ReplyHeader;

/**
 * Interface to a Server connection - represents a connection from a client
 * to the server.
 */
public interface ServerCnxn extends Watcher {
    // This is just an arbitrary object to represent requests issued by
    // (aka owned by) this class
    final public static Object me = new Object();

    int getSessionTimeout();

    void sendResponse(ReplyHeader h, Record r, String tag) throws IOException;

    /* notify the client the session is closing and close/cleanup socket */
    void sendCloseSession();

    void finishSessionInit(boolean valid);

    void process(WatchedEvent event);

    long getSessionId();

    void setSessionId(long sessionId);

    ArrayList<Id> getAuthInfo();

    InetSocketAddress getRemoteAddress();

    /**
     * Statistics on the ServerCnxn
     */
    interface Stats {
        /** Date/time the connection was established
         * @since 3.3.0 */
        Date getEstablished();

        /**
         * The number of requests that have been submitted but not yet
         * responded to.
         */
        long getOutstandingRequests();
        /** Number of packets received */
        long getPacketsReceived();
        /** Number of packets sent (incl notifications) */
        long getPacketsSent();
        /** Min latency in ms
         * @since 3.3.0 */
        long getMinLatency();
        /** Average latency in ms
         * @since 3.3.0 */
        long getAvgLatency();
        /** Max latency in ms
         * @since 3.3.0 */
        long getMaxLatency();
        /** Last operation performed by this connection
         * @since 3.3.0 */
        String getLastOperation();
        /** Last cxid of this connection
         * @since 3.3.0 */
        long getLastCxid();
        /** Last zxid of this connection
         * @since 3.3.0 */
        long getLastZxid();
        /** Last time server sent a response to client on this connection
         * @since 3.3.0 */
        long getLastResponseTime();
        /** Latency of last response to client on this connection in ms
         * @since 3.3.0 */
        long getLastLatency();

        /** Reset counters
         * @since 3.3.0 */
        void reset();
    }

    Stats getStats();
}