Module io.helidon.webclient.api

Package io.helidon.webclient.api

Class UnixDomainSocketClientConnection

java.lang.Object

io.helidon.webclient.api.UnixDomainSocketClientConnection

All Implemented Interfaces:

ClientConnection, ReleasableResource

public class UnixDomainSocketClientConnection
extends Object
implements ClientConnection

Client connection to a UNIX domain socket.

Method Summary

Modifier and Type	Method	Description
boolean	allowExpectContinue()	Check whether this connection is allowed to send 100-Continue.
void	allowExpectContinue(boolean allowExpectContinue)	Set whether this connection allows 100-Continue to be sent.
String	channelId()	Channel id, mostly used in logs.
void	closeResource()	Closes the resource, we cannot use name close, as that would conflict with AutoCloseable, as we do not want to have a checked exception thrown.
UnixDomainSocketClientConnection	connect()	Connect this connection to the socket.
static UnixDomainSocketClientConnection	create(WebClient webClient, Tls tls, List<String> tcpProtocolIds, UnixDomainSocketAddress address, Function<UnixDomainSocketClientConnection,Boolean> releaseFunction, Consumer<UnixDomainSocketClientConnection> closeConsumer)	Create a new UNIX Domain Socket Connection.
HelidonSocket	helidonSocket()	Associated HelidonSocket.
boolean	isConnected()	Check whether this connection is connected.
DataReader	reader()	Data reader providing response bytes.
void	readTimeout(Duration readTimeout)	Read timeout for this connection.
void	releaseResource()	Releases the resource, and if this resource is re-usable, enabled reuse.
DataWriter	writer()	Data writer the client request writes to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

public static UnixDomainSocketClientConnection create(WebClient webClient,
 Tls tls,
 List<String> tcpProtocolIds,
 UnixDomainSocketAddress address,
 Function<UnixDomainSocketClientConnection,Boolean> releaseFunction,
 Consumer<UnixDomainSocketClientConnection> closeConsumer)

Create a new UNIX Domain Socket Connection.

Parameters:

webClient - webclient, to get configuration

tls - TLS configuration

tcpProtocolIds - protocol IDs for ALPN (TLS protocol negotiation)

address - address of the socket

releaseFunction - called when releaseResource() is called, if false is returned, the connection will be closed instead kept open

closeConsumer - called when closeResource() is called, the connection is no longer usable after this moment

Returns:

a new UNIX domain socket connection, connect() must be called to make it available for use

reader

public DataReader reader()

Description copied from interface: ClientConnection

Data reader providing response bytes.

Specified by:

reader in interface ClientConnection

Returns:

reader to read from this connection

writer

public DataWriter writer()

Description copied from interface: ClientConnection

Data writer the client request writes to.

Specified by:

writer in interface ClientConnection

Returns:

writer to write to this connection

channelId

public String channelId()

Description copied from interface: ClientConnection

Channel id, mostly used in logs.

Specified by:

channelId in interface ClientConnection

Returns:

id of this channel (connection)

allowExpectContinue

public boolean allowExpectContinue()

Description copied from interface: ClientConnection

Check whether this connection is allowed to send 100-Continue.

Specified by:

allowExpectContinue in interface ClientConnection

Returns:

whether 100-Continue is allowed

allowExpectContinue

public void allowExpectContinue(boolean allowExpectContinue)

Description copied from interface: ClientConnection

Set whether this connection allows 100-Continue to be sent.

Specified by:

allowExpectContinue in interface ClientConnection

Parameters:

allowExpectContinue - whether to allow 100-Continue

helidonSocket

public HelidonSocket helidonSocket()

Description copied from interface: ClientConnection

Associated HelidonSocket.

Specified by:

helidonSocket in interface ClientConnection

Returns:

socket of this connection

readTimeout

public void readTimeout(Duration readTimeout)

Description copied from interface: ClientConnection

Read timeout for this connection.

Specified by:

readTimeout in interface ClientConnection

Parameters:

readTimeout - connection read timeout

isConnected

public boolean isConnected()

Description copied from interface: ClientConnection

Check whether this connection is connected.

Specified by:

isConnected in interface ClientConnection

Returns:

true if connected, false otherwise

closeResource

public void closeResource()

Description copied from interface: ReleasableResource

Closes the resource, we cannot use name close, as that would conflict with AutoCloseable, as we do not want to have a checked exception thrown.

Specified by:

closeResource in interface ReleasableResource

releaseResource

public void releaseResource()

Description copied from interface: ReleasableResource

Releases the resource, and if this resource is re-usable, enabled reuse.

Specified by:

releaseResource in interface ReleasableResource

connect

public UnixDomainSocketClientConnection connect()

Connect this connection to the socket.

Specified by:

connect in interface ClientConnection

Returns:

this connection, connected to the UNIX domain socket