1.0.1 • Published 7 years ago

@lug/netproxy v1.0.1

Weekly downloads
1
License
MIT
Repository
github
Last release
7 years ago

NetProxy

NetProxy is a simple "interface" that is will be used to wrap a net utils so we can swap between them easily.

Create a new proxy

  • install npm i @lug/netproxy
  • import
const {NetClientProxy, NetServerProxy} = require('@lug/netproxy')
class Server extends NetServerProxy { ... }
class Client extends NetClientProxy { ... }

please see https://github.com/Lughus/NetProxy-events for an example for how it works

Methods

At the end you will have this

  • Server
    • listen(port)
    • stop()
    • send(socket,data)
  • Client
    • connect(ip,port)
    • disconnect()
    • send(data)

and some events that are triggered when it needs to

Events

An event is fired with this.ev.emit('event'[,arg])

Server

eventargtypedescription
errorerroranywhen an error happen
start--when the server start listening
stop--when the server stop
socket.connectsocketsocketwhen a client connect
socket.disconnectsocketsocketwhen a client disconnect
socket.datasocket, datasocket, anywhen a client send data

Client

eventargtypedescription
errorerroranywhen an error happen
connect--when the client is connecting
connectedsocketsocketwhen the client is connected stop
disconnect--when a client disconnect
destroy--when a client is destroyed
datadataanywhen a client recieve data