001/*
002 * Copyright 2012-2017 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.boot.devtools.tunnel.server;
018
019import java.io.IOException;
020import java.nio.channels.ByteChannel;
021
022/**
023 * Manages the connection to the ultimate tunnel target server.
024 *
025 * @author Phillip Webb
026 * @since 1.3.0
027 */
028@FunctionalInterface
029public interface TargetServerConnection {
030
031        /**
032         * Open a connection to the target server with the specified timeout.
033         * @param timeout the read timeout
034         * @return a {@link ByteChannel} providing read/write access to the server
035         * @throws IOException in case of I/O errors
036         */
037        ByteChannel open(int timeout) throws IOException;
038
039}