smartsocket/ts/smartsocket.classes.socketfunction.ts

84 lines
2.3 KiB
TypeScript
Raw Normal View History

2018-03-15 01:29:40 +00:00
import * as plugins from './smartsocket.plugins';
2016-08-07 13:37:52 +00:00
// import classes
import { Objectmap } from '@pushrocks/lik';
2018-03-15 01:29:40 +00:00
import { SocketRole } from './smartsocket.classes.socketrole';
2019-05-02 09:46:36 +00:00
import { SocketConnection } from './smartsocket.classes.socketconnection';
2016-08-07 13:37:52 +00:00
2016-08-09 09:42:21 +00:00
// export interfaces
2016-08-09 16:22:30 +00:00
/**
* interface of the contructor options of class SocketFunction
*/
2016-08-12 01:22:36 +00:00
export interface ISocketFunctionConstructorOptions {
2018-03-15 01:29:40 +00:00
funcName: string;
2019-05-02 09:46:36 +00:00
funcDef: TFuncDef;
2018-03-15 01:29:40 +00:00
allowedRoles: SocketRole[]; // all roles that are allowed to execute a SocketFunction
2017-07-07 20:02:19 +00:00
}
2016-08-07 13:37:52 +00:00
2016-08-09 16:22:30 +00:00
/**
2016-08-12 01:22:36 +00:00
* interface of the Socket Function call, in other words the object that routes a call to a function
2016-08-09 16:22:30 +00:00
*/
export interface ISocketFunctionCall {
2018-03-15 01:29:40 +00:00
funcName: string;
funcDataArg: any;
2017-07-07 20:02:19 +00:00
}
2016-08-12 03:17:13 +00:00
/**
* interface for function definition of SocketFunction
*/
2019-05-02 09:46:36 +00:00
export type TFuncDef = (dataArg: any, connectionArg: SocketConnection) => PromiseLike<any>;
2016-08-09 16:22:30 +00:00
2016-08-12 01:22:36 +00:00
// export objects
2018-03-15 01:29:40 +00:00
export let allSocketFunctions = new Objectmap<SocketFunction>();
2016-08-12 01:22:36 +00:00
2016-08-09 09:42:21 +00:00
// export classes
/**
2016-08-09 16:22:30 +00:00
* class that respresents a function that can be transparently called using a SocketConnection
2016-08-09 09:42:21 +00:00
*/
2016-08-07 13:37:52 +00:00
export class SocketFunction {
2018-03-15 01:29:40 +00:00
name: string;
2019-05-02 09:46:36 +00:00
funcDef: TFuncDef;
2018-03-15 01:29:40 +00:00
roles: SocketRole[];
2016-08-08 16:20:00 +00:00
2017-07-07 20:02:19 +00:00
/**
* the constructor for SocketFunction
*/
2018-03-15 01:29:40 +00:00
constructor(optionsArg: ISocketFunctionConstructorOptions) {
this.name = optionsArg.funcName;
this.funcDef = optionsArg.funcDef;
this.roles = optionsArg.allowedRoles;
2017-07-07 20:02:19 +00:00
for (let socketRoleArg of this.roles) {
2018-03-15 01:29:40 +00:00
this._notifyRole(socketRoleArg);
2017-07-07 20:02:19 +00:00
}
2018-03-15 01:29:40 +00:00
allSocketFunctions.add(this); // map instance with Objectmap
2017-07-07 20:02:19 +00:00
}
2016-08-08 16:20:00 +00:00
2017-07-07 20:02:19 +00:00
/**
* invokes the function of this SocketFunction
*/
2019-05-02 09:46:36 +00:00
invoke(dataArg: ISocketFunctionCall, socketConnectionArg: SocketConnection): Promise<any> {
let done = plugins.smartpromise.defer();
2017-07-07 20:02:19 +00:00
if (dataArg.funcName === this.name) {
2019-05-02 09:46:36 +00:00
this.funcDef(dataArg.funcDataArg, socketConnectionArg).then((resultData: any) => {
2018-03-15 01:29:40 +00:00
let funcResponseData: ISocketFunctionCall = {
funcName: this.name,
funcDataArg: resultData
};
done.resolve(funcResponseData);
});
2017-07-07 20:02:19 +00:00
} else {
2018-03-15 01:29:40 +00:00
throw new Error("SocketFunction.name does not match the data argument's .name!");
2016-08-08 16:20:00 +00:00
}
2018-03-15 01:29:40 +00:00
return done.promise;
2017-07-07 20:02:19 +00:00
}
2016-08-08 16:20:00 +00:00
2017-07-07 20:02:19 +00:00
/**
* notifies a role about access to this SocketFunction
*/
2018-03-15 01:29:40 +00:00
private _notifyRole(socketRoleArg: SocketRole) {
socketRoleArg.addSocketFunction(this);
2017-07-07 20:02:19 +00:00
}
}