tgrid/lib/components/Invoke.d.ts

Grid Computing Framework for TypeScript

/**
 * Message structure for RPC (Remote Procedure Call).
 *
 * @author Jeongho Nam - https://github.com/samchon
 */
export type Invoke = Invoke.IFunction | Invoke.IReturn;
export declare namespace Invoke {
    /**
     * Message for Requesting RPC.
     */
    interface IFunction {
        /**
         * Unique identifier.
         */
        readonly uid: number;
        /**
         * Target function (sometimes capsuled in objects) to call.
         */
        readonly listener: string;
        /**
         * Parameters for the function call.
         */
        parameters: IParameter[];
    }
    /**
     * Parameter for the function call.
     */
    interface IParameter {
        /**
         * Type of the {@link value}.
         *
         * Actually, it stores result of the `typeof` statement.
         */
        type: string;
        /**
         * Value of the parameter.
         */
        value: any;
    }
    /**
     * Message for Returning RPC.
     */
    interface IReturn {
        /**
         * Unique identifier.
         */
        readonly uid: number;
        /**
         * `true` -> return, `false` -> exception.
         */
        readonly success: boolean;
        /**
         * Returned value or thrown exception.
         */
        value: any;
    }
}