tgrid
Version:
Grid Computing Framework for TypeScript
82 lines (81 loc) • 2.91 kB
TypeScript
import { Communicator } from "../../components/Communicator";
/**
* Basic Acceptor.
*
* The `AcceptorBase` is an abstract acceptor class, who can accept or reject connection from
* a remote client in the server side. If the client's connection has been accepted, the
* `AcceptorBase` can start interaction with the client through the
* [RFC](https://github.com/samchon/tgrid#13-remote-function-call) (Remote Function Call).
*
* Also, when declaring this {@link AcceptorBase} type, you've to define two template arguments,
* *Header* and *Provider*. The *Header* type represents an initial data gotten from the remote
* client after the connection. I hope you and client not to omit it and utilize it as an
* activation tool to enhance security.
*
* The second template argument *Provider* represents the features provided for the remote client.
* If you don't have any plan to provide any feature to the remote client, just declare it as
* `null`.
*
* @template Header Type of the header containing initial data.
* @template Provider Type of features provided for the remote system.
* @template Remote Type of features supported by remote system, used for {@link getDriver} function.
* @author Jeongho Nam - https://github.com/samchon
*/
export declare abstract class AcceptorBase<Header, Provider extends object | null, Remote extends object | null> extends Communicator<Provider | undefined, Remote> {
/**
* @hidden
*/
private readonly header_;
/**
* @hidden
*/
protected state_: AcceptorBase.State;
/**
* @hidden
*/
protected constructor(header: Header);
/**
* Accept connection.
*
* Accepts (permits) the client's connection with this server and starts interaction.
*
* @param provider An object providing features for remote system.
*/
protected abstract accept(provider: Provider | null): Promise<void>;
/**
* Header containing initialization data like activation.
*/
get header(): Header;
/**
* Get state.
*
* Get current state of connection state with the remote client.
*
* List of values are such like below:
*
* - `REJECTING`: The `reject` method is on running.
* - `NONE`: This instance is newly created, but did nothing yet.
* - `ACCEPTING`: The `accept` method is on running.
* - `OPEN`: The connection is online.
* - `CLOSING`: The `close` method is on running.
* - `CLOSED`: The connection is offline.
*/
get state(): AcceptorBase.State;
/**
* @hidden
*/
protected inspectReady(method: string): Error | null;
}
export declare namespace AcceptorBase {
/**
* Current state type of acceptor.
*/
const enum State {
REJECTING = -2,
NONE = -1,
ACCEPTING = 0,
OPEN = 1,
CLOSING = 2,
CLOSED = 3
}
}