smartsocket/ts/smartsocket.classes.socketfunction.ts

import * as plugins from "./smartsocket.plugins";

// import classes
import { Stringmap } from "lik";
import { SocketRole } from "./smartsocket.classes.socketrole";

// export interfaces

export interface ISocketFunctionRequestObject {
    functionName:string,
    argumentObject:any,
    shortId:string,
    responseTimeout?:number
};

export interface ISocketFunctionResponseObject {
    shortId:string;
    argumentObject:any;
};

export interface SocketFunctionOptions {
    name: string;
    func: any;
    roles: SocketRole[]; // all roles that are allowed to execute a SocketFunction
};

// export classes

/**
 * class SocketFunction respresents a function that can be transparently called using a SocketConnection
 */
export class SocketFunction {
    name: string;
    func: any;
    roles: SocketRole[];

    /**
     * the constructor for SocketFunction
     */
    constructor(optionsArg: SocketFunctionOptions) {
        this.name = optionsArg.name;
        this.func = optionsArg.func;
        this.roles = optionsArg.roles;
        for (let socketRoleArg of this.roles){
            this._notifyRole(socketRoleArg);
        }
    };

    /** 
     * notifies a role about access to this SocketFunction
     */
    private _notifyRole(socketRoleArg:SocketRole){
        socketRoleArg.addSocketFunction(this);
    }
    
    /**
     * invokes the function of this SocketFunction
     */
    invoke(dataArg:ISocketFunctionRequestObject){
        
    };

}