org.apache.sshd.common.io.IoConnector Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sshd-common Show documentation

The newest version!

/*
 * 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.sshd.common.io;

import java.net.SocketAddress;

import org.apache.sshd.common.AttributeRepository;

/**
 * @author Apache MINA SSHD Project
 */
public interface IoConnector extends IoService {
    /**
     * @param  targetAddress The target address to connect to
     * @param  context       An optional "context" to be attached to the established session if successfully
     *                       connected
     * @param  localAddress  The local address to use - if {@code null} an automatic ephemeral port and bind address is
     *                       used
     * @return               The {@link IoConnectFuture future} representing the connection request
     */
    IoConnectFuture connect(
            SocketAddress targetAddress, AttributeRepository context, SocketAddress localAddress);
}