me.lucko.helper.messaging.reqresp

Interface ReqRespChannel<Req,Resp>

Type Parameters:

Req - the request type

Resp - the response type

All Superinterfaces:

AutoCloseable, Terminable

All Known Implementing Classes:

SimpleReqRespChannel

public interface ReqRespChannel<Req,Resp>
extends Terminable

A generic request/response handler that can operate over the network.

This is a high-level interface, implemented in SimpleReqRespChannel using lower-level ConversationChannels and Channels.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	ReqRespChannel.AsyncResponseHandler<Req,Resp>
static interface	ReqRespChannel.ResponseHandler<Req,Resp>

Field Summary

Fields inherited from interface me.lucko.helper.terminable.Terminable

EMPTY

Method Summary

Modifier and Type	Method and Description
void	asyncResponseHandler(ReqRespChannel.AsyncResponseHandler<Req,Resp> handler) Registers a response handler that returns a Promise.
Promise<Resp>	request(Req req) Sends a request and returns a promise encapsulating the response.
void	responseHandler(ReqRespChannel.ResponseHandler<Req,Resp> handler) Registers a response handler.

Methods inherited from interface me.lucko.helper.terminable.Terminable

bindWith, close, closeAndReportException, closeSilently, isClosed

Method Detail

request

Promise<Resp> request(Req req)

Sends a request and returns a promise encapsulating the response.

The promise will complete exceptionally if a response is not received before the timeout expires, by default after 5 seconds.

Parameters:

req - the request object

Returns:

a promise encapsulating the response

responseHandler

void responseHandler(ReqRespChannel.ResponseHandler<Req,Resp> handler)

Registers a response handler.

Parameters:

handler - the response handler

asyncResponseHandler

void asyncResponseHandler(ReqRespChannel.AsyncResponseHandler<Req,Resp> handler)

Registers a response handler that returns a Promise.

Parameters:

handler - the response handler