@xmobitea/gn-server
Version:
GearN Server by XmobiTea (Pro)
78 lines (77 loc) • 2.44 kB
TypeScript
import { SocketAppSettings } from "./settings/SocketAppSettings";
import { Server } from "socket.io";
import http from "http";
import { SocketAppHandler } from "./routes/SocketAppHandler";
import { Emitter } from "@socket.io/mongo-emitter";
import * as mongodb from "mongodb";
import { ApiMiddleware } from "./middleware/ApiMiddleware";
import { AntiDdosMiddleware } from "./middleware/AntiDdosMiddleware";
import { GNServer } from "./../GNServer";
export declare class SocketApp {
private appSettings;
private server;
private socketAppHandler;
private apiMiddleware;
private antiDdosMiddleware;
private io;
private gnServer;
private emitter;
/**
* Sets the server.
* @param server Provides the server value used by this operation.
*/
setServer(server: http.Server): void;
/**
* Sets the GearN server.
* @param gnServer Provides the GearN server value used by this operation.
*/
setGNServer(gnServer: GNServer): void;
/**
* Returns the HTTP server.
* @returns Returns the HTTP server.
*/
getHttpServer(): http.Server;
/**
* Returns the IO.
* @returns Returns the IO.
*/
getIO(): Server;
/**
* Returns the emitter.
* @returns Returns the emitter.
*/
getEmitter(): Emitter;
/**
* Returns the socket app handler.
* @returns Returns the socket app handler.
*/
getSocketAppHandler(): SocketAppHandler;
/**
* Sets the API middleware.
* @param apiMiddleware Provides the API middleware value used by this operation.
*/
setApiMiddleware(apiMiddleware: ApiMiddleware): void;
/**
* Sets the app settings.
* @param appSettings Provides the app settings value used by this operation.
*/
setAppSettings(appSettings: SocketAppSettings): void;
/**
* Sets the anti DDoS middleware.
* @param antiDdosMiddleware Provides the anti DDoS middleware value used by this operation.
*/
setAntiDdosMiddleware(antiDdosMiddleware: AntiDdosMiddleware): void;
/**
* Runs the current workflow.
*/
run(): void;
/**
* Sets the emitter.
* @param adapterEventCollection Provides the adapter event collection used by this operation.
*/
setEmitter(adapterEventCollection: mongodb.Collection<mongodb.Document>): void;
/**
* Initializes a new socket app instance.
*/
constructor();
}