com.hazelcast.client.connection.ClientConnectionManager Maven / Gradle / Ivy
/*
* Copyright (c) 2008-2016, Hazelcast, Inc. All Rights Reserved.
*
* 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.hazelcast.client.connection;
import com.hazelcast.client.impl.protocol.ClientMessage;
import com.hazelcast.client.spi.impl.ConnectionHeartbeatListener;
import com.hazelcast.nio.Address;
import com.hazelcast.nio.Connection;
import com.hazelcast.nio.ConnectionListenable;
import java.io.IOException;
/**
* Responsible for managing {@link com.hazelcast.client.connection.nio.ClientConnection} objects.
*/
public interface ClientConnectionManager extends ConnectionListenable {
/**
* Shutdown clientConnectionManager
*/
void shutdown();
/**
* Check if client connection manager is alive.
* ClientConnectionManager is not alive only when client is closing.
*
* @return true if alive, false otherwise.
*/
boolean isAlive();
/**
* Start clientConnectionManager
*/
void start();
/**
* @param address to be connected
* @return connection if available, null otherwise
*/
Connection getConnection(Address address);
/**
* @param address to be connected
* @param asOwner true if connection should be authenticated as owner, false otherwise
* @return associated connection if available, creates new connection otherwise
* @throws IOException if connection is not established
*/
Connection getOrConnect(Address address, boolean asOwner) throws IOException;
/**
* @param address to be connected
* @param asOwner true if connection should be authenticated as owner, false otherwise
* @return associated connection if available, returns null and triggers new connection creation otherwise
*/
Connection getOrTriggerConnect(Address address, boolean asOwner);
/**
* Destroys the connection
* Clears related resources of given connection.
* ConnectionListener.connectionRemoved is called on registered listeners.
*
* If connection is already destroyed before calling this then does nothing.
*
* @param connection to be closed
* @param reason the reason of closing this exception. Can be null if no reason is given.
* @param cause exception that cause connection to be closed, null if closed explicitly
*/
void destroyConnection(Connection connection, String reason, Throwable cause);
/**
* Handles incoming network package
*
* @param message to be processed
* @param connection that client message come from
*/
void handleClientMessage(ClientMessage message, Connection connection);
void addConnectionHeartbeatListener(ConnectionHeartbeatListener connectionHeartbeatListener);
}