import { Disposable } from '../disposable'; import { Emitter, Event } from '../event'; import { Channel } from '../message-rpc/channel'; import { RequestHandler, RpcProtocol } from '../message-rpc/rpc-protocol'; import { ConnectionHandler } from './handler'; export declare type JsonRpcServer = Disposable & { /** * If this server is a proxy to a remote server then * a client is used as a local object * to handle JSON-RPC messages from the remote server. */ setClient(client: Client | undefined): void; getClient?(): Client | undefined; }; export interface JsonRpcConnectionEventEmitter { readonly onDidOpenConnection: Event; readonly onDidCloseConnection: Event; } export declare type JsonRpcProxy = T & JsonRpcConnectionEventEmitter; export declare class JsonRpcConnectionHandler implements ConnectionHandler { readonly path: string; readonly targetFactory: (proxy: JsonRpcProxy) => any; readonly factoryConstructor: new () => JsonRpcProxyFactory; constructor(path: string, targetFactory: (proxy: JsonRpcProxy) => any, factoryConstructor?: new () => JsonRpcProxyFactory); onConnection(connection: Channel): void; } /** * Factory for creating a new {@link RpcConnection} for a given chanel and {@link RequestHandler}. */ export declare type RpcConnectionFactory = (channel: Channel, requestHandler: RequestHandler) => RpcProtocol; /** * Factory for JSON-RPC proxy objects. * * A JSON-RPC proxy exposes the programmatic interface of an object through * JSON-RPC. This allows remote programs to call methods of this objects by * sending JSON-RPC requests. This takes place over a bi-directional stream, * where both ends can expose an object and both can call methods each other's * exposed object. * * For example, assuming we have an object of the following type on one end: * * class Foo { * bar(baz: number): number { return baz + 1 } * } * * which we want to expose through a JSON-RPC interface. We would do: * * let target = new Foo() * let factory = new JsonRpcProxyFactory('/foo', target) * factory.onConnection(connection) * * The party at the other end of the `connection`, in order to remotely call * methods on this object would do: * * let factory = new JsonRpcProxyFactory('/foo') * factory.onConnection(connection) * let proxy = factory.createProxy(); * let result = proxy.bar(42) * // result is equal to 43 * * One the wire, it would look like this: * * --> {"jsonrpc": "2.0", "id": 0, "method": "bar", "params": {"baz": 42}} * <-- {"jsonrpc": "2.0", "id": 0, "result": 43} * * Note that in the code of the caller, we didn't pass a target object to * JsonRpcProxyFactory, because we don't want/need to expose an object. * If we had passed a target object, the other side could've called methods on * it. * * @param - The type of the object to expose to JSON-RPC. */ export declare class JsonRpcProxyFactory implements ProxyHandler { target?: any; protected rpcConnectionFactory: RpcConnectionFactory; protected readonly onDidOpenConnectionEmitter: Emitter; protected readonly onDidCloseConnectionEmitter: Emitter; protected connectionPromiseResolve: (connection: RpcProtocol) => void; protected connectionPromise: Promise; /** * Build a new JsonRpcProxyFactory. * * @param target - The object to expose to JSON-RPC methods calls. If this * is omitted, the proxy won't be able to handle requests, only send them. */ constructor(target?: any, rpcConnectionFactory?: RpcConnectionFactory); protected waitForConnection(): void; /** * Connect a MessageConnection to the factory. * * This connection will be used to send/receive JSON-RPC requests and * response. */ listen(channel: Channel): void; /** * Process an incoming JSON-RPC method call. * * onRequest is called when the JSON-RPC connection received a method call * request. It calls the corresponding method on [[target]]. * * The return value is a Promise object that is resolved with the return * value of the method call, if it is successful. The promise is rejected * if the called method does not exist or if it throws. * * @returns A promise of the method call completion. */ protected onRequest(method: string, ...args: any[]): Promise; /** * Process an incoming JSON-RPC notification. * * Same as [[onRequest]], but called on incoming notifications rather than * methods calls. */ protected onNotification(method: string, ...args: any[]): void; /** * Create a Proxy exposing the interface of an object of type T. This Proxy * can be used to do JSON-RPC method calls on the remote target object as * if it was local. * * If `T` implements `JsonRpcServer` then a client is used as a target object for a remote target object. */ createProxy(): JsonRpcProxy; /** * Get a callable object that executes a JSON-RPC method call. * * Getting a property on the Proxy object returns a callable that, when * called, executes a JSON-RPC call. The name of the property defines the * method to be called. The callable takes a variable number of arguments, * which are passed in the JSON-RPC method call. * * For example, if you have a Proxy object: * * let fooProxyFactory = JsonRpcProxyFactory('/foo') * let fooProxy = fooProxyFactory.createProxy() * * accessing `fooProxy.bar` will return a callable that, when called, * executes a JSON-RPC method call to method `bar`. Therefore, doing * `fooProxy.bar()` will call the `bar` method on the remote Foo object. * * @param target - unused. * @param p - The property accessed on the Proxy object. * @param receiver - unused. * @returns A callable that executes the JSON-RPC call. */ get(target: T, p: PropertyKey, receiver: any): any; /** * Return whether the given property represents a notification. * * A property leads to a notification rather than a method call if its name * begins with `notify` or `on`. * * @param p - The property being called on the proxy. * @return Whether `p` represents a notification. */ protected isNotification(p: PropertyKey): boolean; protected serializeError(e: any): any; protected deserializeError(capturedError: Error, e: any): any; } //# sourceMappingURL=proxy-factory.d.ts.map