attributes of the server
Can connections of this server use the chat system?
Shorthand for api.config.servers[this.type]
Methods descibed by the server to apply to each connection (like connection.setHeader for web connections)
An optional message to send to clients when they disconnect
Should we log every new connection?
Should we log when a connection disconnects/exits?
Should every new connection of this server type recieve the wecome message (defiend in locales, actionhero.welcomeMessage)
A place to store the actuall server object you create
The name & type of the server.
What connection verbs can connections of this type use?
this.buildConnection({
rawConnection: {
req: req,
res: res,
params: {},
method: method,
cookies: cookies,
responseHeaders: responseHeaders,
responseHttpCode: responseHttpCode,
parsedURL: parsedURL
},
id: fingerprint + '-' + uuid.v4(),
fingerprint: fingerprint,
remoteAddress: remoteIP,
remotePort: remotePort
})Enumerate the connections for this server type on this server.
Method run as part of the initialize lifecycle of your server. Ususally configures the server.
Log a message from this server type. A wrapper around log() with a server prefix.
When a connection has called an Action command, and all properties are set. Connection should have params.action set at least.
on(event: 'actionComplete', cb: (data: object) => void): this;
When a connection has called an File command, and all properties are set. Connection should have params.file set at least. Will eventuall call ActionHero.Server#sendFile.
Must be defined explaining how to send a file to an induvidual connection. Might be a noop for some connection types.
Must be defined explaining how to send a message to an induvidual connection.
Method run as part of the start lifecycle of your server. Ususally boots the server (listens on port, etc).
Method run as part of the stop lifecycle of your server. Ususally configures the server (disconnects from port, etc).
Generated using TypeDoc
Create a new ActionHero Server. The required properties of an server. These can be defined statically (this.name) or as methods which return a value.