001/* 002 * Copyright 2012-2018 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.client; 018 019import java.io.Closeable; 020import java.nio.channels.WritableByteChannel; 021 022/** 023 * Interface used to manage socket tunnel connections. 024 * 025 * @author Phillip Webb 026 * @since 1.3.0 027 */ 028@FunctionalInterface 029public interface TunnelConnection { 030 031 /** 032 * Open the tunnel connection. 033 * @param incomingChannel a {@link WritableByteChannel} that should be used to write 034 * any incoming data received from the remote server 035 * @param closeable a closeable to call when the channel is closed 036 * @return a {@link WritableByteChannel} that should be used to send any outgoing data 037 * destined for the remote server 038 * @throws Exception in case of errors 039 */ 040 WritableByteChannel open(WritableByteChannel incomingChannel, Closeable closeable) 041 throws Exception; 042 043}