Packetgun-backend by willmil11

Installation

If you have node.js and npm installed you can run the following command in the terminal.

1npm install packetgun-backend

Usage

This package is designed to be used with packetgun-frontend as client.

First require the package:

1var packetgun = require("packetgun-backend");

Then init the package if you don't everything else that you do will throw an error. The syntax is as below

1packetgun.init(verbose, custom-prefix)
2//Verbose must be boolean or unspecified (which counts as false)
3//Custom-prefix must be a string or unspecified

Classic method

To listen with classic method you need to do as below:

1//Listen for requests
2packetgun.listen.classic(port, function(client){
3    //Got request
4
5    //Log client ip
6    console.log(client.ip);
7    //Log request exit code
8    console.log(client.exit_code);
9    //Log client exit code
10    console.log(client.client_exit_code);
11    //Log client data
12    console.log(client.data);
13
14    //Return a response
15    //
16    //exit_code will be server_exit_code on the client side
17    return {
18        exit_code: 0,
19        data: "Hello world!"
20    }
21})

This method is not recommended because the size of the client upload data (including exit_code) is limitted to 255 chars/bytes, Also this method is unidirectional as it uses http: client to server not the other way around.

Recommended method

To listen with recommended method you need to do as below:

1//Listen for clients
2packetgun.listen.recommended(port, function(client){
3    //This method uses a different approach to the classic method, this callback is ran when a new client connects.
4
5    //Set an event for receiving data
6    client.on("data", function(data){
7        //Log request exit code
8        console.log(client.exit_code);
9        //Log client exit code
10        console.log(client.client_exit_code);
11        //Log client data
12        console.log(client.data);
13    })
14
15    //Set an event for client disconnect
16    client.on("clientDisconnect", function(){
17        console.log("Client disconnected");
18    })
19
20    //Send data to the client (whenever you want and as many times as you want if the client is connected)
21    client.send({
22        exit_code: 0,
23        data: "Hello world!"
24    })
25
26    //Close the connection (For the demo 5 seconds after the client connects)
27    setTimeout(function(){
28        client.close();
29    }, 5000)
30})

This method is recommended because it is bidirectional (client to server and server to client) as it uses websockets. Also the size of the client upload data (including exit_code) is unlimited.

Future goals

• Encryption
• Better error handling
• Recommended method auto reconnection
• Classic method multiple part uploads (to avoid the 255 chars/bytes client upload limit)

Changelog

1.0.0

• Initial release

Creator and credits

The creator of this package is willmil11 (me).

Used easynodes for this package. easynodes uses other packages which credits can be found in it's readme. easynodes is also created by me.