io.servicetalk.transport.api

Interface ConnectionAcceptor

All Superinterfaces:

AsyncCloseable

All Known Implementing Classes:

DelegatingConnectionAcceptor

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 ConnectionAcceptor
extends AsyncCloseable

A contract that defines the connection acceptance criterion.

Field Summary

Fields

Modifier and Type	Field and Description
static ConnectionAcceptor	ACCEPT_ALL ACCEPT all connections.

Method Summary

Modifier and Type	Method and Description
Completable	accept(ConnectionContext context) Evaluate the passed ConnectionContext to accept or reject.
default ConnectionAcceptor	append(ConnectionAcceptor after) Returns a composed ConnectionAcceptor that first applies this ConnectionAcceptor, and if this is successful then applies after ConnectionAcceptor.
default Completable	closeAsync() Used to close/shutdown a resource.

Methods inherited from interface io.servicetalk.concurrent.api.AsyncCloseable

closeAsyncGracefully

Field Detail

ACCEPT_ALL

static final ConnectionAcceptor ACCEPT_ALL

ACCEPT all connections.

Method Detail

accept

Completable accept(ConnectionContext context)

Evaluate the passed ConnectionContext to accept or reject. If the returned Completable terminates successfully then the passed ConnectionContext will be accepted, otherwise rejected.

Parameters:

context - the ConnectionContext to evaluate.

Returns:

Completable, which when terminated successfully, the passed ConnectionContext is accepted, otherwise rejected.

append

default ConnectionAcceptor append(ConnectionAcceptor after)

Returns a composed ConnectionAcceptor that first applies this ConnectionAcceptor, and if this is successful then applies after ConnectionAcceptor.

The order of execution of these filters are in order of append. If 3 filters are added as follows:

     this.append(filter1).append(filter2).append(filter3)
 

accepting a connection by a filter wrapped by this filter chain, the order of invocation of these filters will be:

     this => filter1 => filter2 => filter3
 

Parameters:

after - the ConnectionAcceptor to apply after this ConnectionAcceptor is applied

Returns:

a composed ConnectionAcceptor that first applies this ConnectionAcceptor, and if this is successful then applies after ConnectionAcceptor.

closeAsync

default Completable closeAsync()

Description copied from interface: AsyncCloseable

Used to close/shutdown a resource.

Specified by:

closeAsync in interface AsyncCloseable

Returns:

A CompletableSource that is notified once the close is complete.