com.mongodb.internal.connection.Server Maven / Gradle / Ivy
Show all versions of mongodb-driver-core Show documentation
/*
* 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.annotations.ThreadSafe;
import com.mongodb.internal.async.SingleResultCallback;
/**
* A logical connection to a MongoDB server.
*
* This class is not part of the public API and may be removed or changed at any time
*/
@ThreadSafe
public interface Server {
/**
* Gets a connection to this server. The connection should be released after the caller is done with it.
*
* Implementations of this method are allowed to block while waiting for a free connection from a pool of available connection.
*
* Implementations of this method will likely pool the underlying connection, so the effect of closing the returned connection will
* be to return the connection to the pool.
*
* @param operationContext operation context
* @return a connection this server
*/
Connection getConnection(OperationContext operationContext);
/**
* Gets a connection to this server asynchronously. The connection should be released after the caller is done with it.
*
* Implementations of this method will likely pool the underlying connection, so the effect of closing the returned connection will
* be to return the connection to the pool.
*
* @param operationContext operation context
* @param callback the callback to execute when the connection is available or an error occurs
*/
void getConnectionAsync(OperationContext operationContext, SingleResultCallback callback);
/**
* An approximation of the
*
* number of operations that this server is currently executing.
*
* @return A negative value iff the server does not track its operation count.
*/
int operationCount();
}