smartsocket/dist/smartsocket.classes.socketfunction.d.ts

37 lines
973 B
TypeScript
Raw Normal View History

2016-08-07 16:59:39 +00:00
import { SocketRole } from "./smartsocket.classes.socketrole";
2016-08-09 09:42:21 +00:00
export interface ISocketFunctionRequestObject {
2016-08-08 16:20:00 +00:00
functionName: string;
2016-08-09 09:42:21 +00:00
argumentObject: any;
shortId: string;
2016-08-08 16:20:00 +00:00
responseTimeout?: number;
}
2016-08-09 09:42:21 +00:00
export interface ISocketFunctionResponseObject {
shortId: string;
argumentObject: any;
}
2016-08-07 16:59:39 +00:00
export interface SocketFunctionOptions {
name: string;
func: any;
roles: SocketRole[];
}
2016-08-09 09:42:21 +00:00
/**
* class SocketFunction respresents a function that can be transparently called using a SocketConnection
*/
2016-08-07 16:59:39 +00:00
export declare class SocketFunction {
name: string;
func: any;
roles: SocketRole[];
2016-08-09 09:42:21 +00:00
/**
* the constructor for SocketFunction
*/
2016-08-07 16:59:39 +00:00
constructor(optionsArg: SocketFunctionOptions);
2016-08-09 09:42:21 +00:00
/**
* notifies a role about access to this SocketFunction
*/
2016-08-08 16:20:00 +00:00
private _notifyRole(socketRoleArg);
2016-08-09 09:42:21 +00:00
/**
* invokes the function of this SocketFunction
*/
invoke(dataArg: ISocketFunctionRequestObject): void;
2016-08-07 16:59:39 +00:00
}