org.springframework.boot.devtools.tunnel.client

Interface TunnelConnection

All Known Implementing Classes:

HttpTunnelConnection

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface TunnelConnection

Interface used to manage socket tunnel connections.

Since:

1.3.0

Author:

Phillip Webb

Method Summary

Modifier and Type	Method and Description
WritableByteChannel	open(WritableByteChannel incomingChannel, Closeable closeable) Open the tunnel connection.

Method Detail

open

WritableByteChannel open(WritableByteChannel incomingChannel,
                         Closeable closeable)
                  throws Exception

Open the tunnel connection.

Parameters:

incomingChannel - a WritableByteChannel that should be used to write any incoming data received from the remote server

closeable - a closeable to call when the channel is closed

Returns:

a WritableByteChannel that should be used to send any outgoing data destined for the remote server

Throws:

Exception - in case of errors