/*
 * Copyright 2008-present MongoDB, Inc.
 *
 * Licensed 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 com.mongodb.internal.connection;

import com.mongodb.async.SingleResultCallback;
import com.mongodb.connection.BufferProvider;
import com.mongodb.connection.ConnectionDescription;
import com.mongodb.session.SessionContext;
import org.bson.ByteBuf;
import org.bson.codecs.Decoder;

import java.util.List;

public interface InternalConnection extends BufferProvider {

    
Gets the description of this connection.
Returns:
the connection description/**
     * Gets the description of this connection.
     *
     * @return the connection description
     */
    ConnectionDescription getDescription();

    
Opens the connection so its ready for use
/**
     * Opens the connection so its ready for use
     */
    void open();

    
Opens the connection so its ready for use
Params:
callback – the callback to be called once the connection has been opened/**
     * Opens the connection so its ready for use
     *
     * @param callback the callback to be called once the connection has been opened
     */
    void openAsync(SingleResultCallback<Void> callback);

    
Closes the connection.
/**
     * Closes the connection.
     */
    void close();

    
Returns if the connection has been opened
Returns:
true if connection has been opened/**
     * Returns if the connection has been opened
     *
     * @return true if connection has been opened
     */
    boolean opened();

    
Returns the closed state of the connection
Returns:
true if connection is closed/**
     * Returns the closed state of the connection
     *
     * @return true if connection is closed
     */
    boolean isClosed();

    
Send a command message to the server.
Params:
message –   the command message to send
sessionContext – the session context/**
     * Send a command message to the server.
     *
     * @param message   the command message to send
     * @param sessionContext the session context
     */
    <T> T sendAndReceive(CommandMessage message, Decoder<T> decoder, SessionContext sessionContext);

    
Send a command message to the server.
Params:
message –   the command message to send
sessionContext – the session context
callback – the callback/**
     * Send a command message to the server.
     *
     * @param message   the command message to send
     * @param sessionContext the session context
     * @param callback the callback
     */
    <T> void sendAndReceiveAsync(CommandMessage message, Decoder<T> decoder, SessionContext sessionContext,
                                 SingleResultCallback<T> callback);

    
Send a message to the server. The connection may not make any attempt to validate the integrity of the message.
Params:
byteBuffers –   the list of byte buffers to send.
lastRequestId – the request id of the last message in byteBuffers/**
     * Send a message to the server. The connection may not make any attempt to validate the integrity of the message.
     *
     * @param byteBuffers   the list of byte buffers to send.
     * @param lastRequestId the request id of the last message in byteBuffers
     */
    void sendMessage(List<ByteBuf> byteBuffers, int lastRequestId);

    
Receive a response to a sent message from the server.
Params:
responseTo – the request id that this message is a response to
Returns:
the response/**
     * Receive a response to a sent message from the server.
     *
     * @param responseTo the request id that this message is a response to
     * @return the response
     */
    ResponseBuffers receiveMessage(int responseTo);

    
Asynchronously send a message to the server. The connection may not make any attempt to validate the integrity of the message.
Params:
byteBuffers –   the list of byte buffers to send
lastRequestId – the request id of the last message in byteBuffers
callback –      the callback to invoke on completion/**
     * Asynchronously send a message to the server. The connection may not make any attempt to validate the integrity of the message.
     *
     * @param byteBuffers   the list of byte buffers to send
     * @param lastRequestId the request id of the last message in byteBuffers
     * @param callback      the callback to invoke on completion
     */
    void sendMessageAsync(List<ByteBuf> byteBuffers, int lastRequestId, SingleResultCallback<Void> callback);

    
Asynchronously receive a response to a sent message from the server.
Params:
responseTo – the request id that this message is a response to
callback – the callback to invoke on completion/**
     * Asynchronously receive a response to a sent message from the server.
     *
     * @param responseTo the request id that this message is a response to
     * @param callback the callback to invoke on completion
     */
    void receiveMessageAsync(int responseTo, SingleResultCallback<ResponseBuffers> callback);

}