org.littleshoot.mina.common.IoConnector Maven / Gradle / Ivy
/*
* 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.littleshoot.mina.common;
import java.net.SocketAddress;
/**
* Connects to endpoint, communicates with the server, and fires events to
* {@link IoHandler}s.
*
* Please refer to
* NetCat
* example.
*
* You should connect to the desired socket address to start communication,
* and then events for incoming connections will be sent to the specified
* default {@link IoHandler}.
*
* Threads connect to endpoint start automatically when
* {@link #connect(SocketAddress, IoHandler)} is invoked, and stop when all
* connection attempts are finished.
*
* @author The Apache Directory Project ([email protected])
* @version $Rev: 555855 $, $Date: 2007-07-13 12:19:00 +0900 (Fri, 13 Jul 2007) $
*/
public interface IoConnector extends IoService {
/**
* Connects to the specified address. If communication starts
* successfully, events are fired to the specified
* handler.
*
* @return {@link ConnectFuture} that will tell the result of the connection attempt
*/
ConnectFuture connect(SocketAddress address, IoHandler handler);
/**
* Connects to the specified address. If communication starts
* successfully, events are fired to the specified
* handler.
*
* @param config the configuration
* @return {@link ConnectFuture} that will tell the result of the connection attempt
*/
ConnectFuture connect(SocketAddress address, IoHandler handler,
IoServiceConfig config);
/**
* Connects to the specified address. If communication starts
* successfully, events are fired to the specified
* handler.
*
* @param localAddress the local address the channel is bound to
* @return {@link ConnectFuture} that will tell the result of the connection attempt
*/
ConnectFuture connect(SocketAddress address, SocketAddress localAddress,
IoHandler handler);
/**
* Connects to the specified address. If communication starts
* successfully, events are fired to the specified
* handler.
*
* @param config the configuration
* @return {@link ConnectFuture} that will tell the result of the connection attempt
*/
ConnectFuture connect(SocketAddress address, SocketAddress localAddress,
IoHandler handler, IoServiceConfig config);
}