Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
tcp-emitter-client
Advanced tools
Readme
TCP Emitter Client
is an EventEmitter that can connect with a TCP Emitter Server to interact with other connected clients.
npm install --save tcp-emitter-client
Options | Type | Default | Description |
---|---|---|---|
options.delimiter | string | '@@@' | Delimiter used to seperate payloads in a single TCP request. More info here. |
net.Socket object used to connect the TCP Emitter client
with the TCP Emitter server
.
Function used to connect the TCP Emitter client
with a TCP Emitter server
.
Alias to client.socket.connect.
Function used to disconnect the TCP Emitter client
from the TCP Emitter server
.
Alias to client.socket.end.
When a TCP Emitter client
is connected to a TCP Emitter server
, apart from functioning as a normal EventEmitter, it will need to interact with the TCP Emitter server
it is connected to through TCP requests. The following section describes when this client sends each type of request.
TCP Emitter client
connects with a TCP Emitter server
it will subscribe to all the events it has registered listeners.TCP Emitter client
is connected to a TCP Emitter server
and a first listener is added to an event.TCP Emitter client
is connected to a TCP Emitter server
and a last listener is removed from an event.TCP Emitter client
is connected to a TCP Emitter server
and an event is emitted.// Create a new TCP Emitter client.
const clientInst = require('tcp-emitter-client')()
// Function to serve as a listener for this example.
const listener = (name) => console.log(`Hello ${name}`)
// When adding a listener to an event before connecting to a TCP Emitter server,
// TCP Emitter client will function as a normal EventEmitter and thus refrain
// from sending a TCP Emitter subscribe request.
clientInst.on('new-user', listener)
// When connecting to a TCP Emitter server, TCP Emitter client will subscribe to
// all the events it currently has registered. By doing this its listeners will
// be invoked when a connected client emits the same events.
clientInst.connect(8080)
// When adding the first listener to an event in TCP Emitter client after
// connecting to a TCP Emitter server, TCP Emitter client will automatically
// send a TCP Emitter Subscribe request to the TCP Emitter server it is
// connected to. By doing this the listener & future listeners of the event will
// be invoked whenever a connected client emits the same event.
clientInst.on('remove-user', listener)
// When removing the last listener from a TCP Emitter client after connecting to
// a TCP Emitter server, TCP Emitter client will automatically send a TCP
// Emitter Unsubscribe request to the TCP Emitter server it is connected to.
clientInst.removeListener('remove-user', listener)
// When emitting an event after connecting the TCP Emitter client to a TCP
// Emitter server, TCP Emitter client will automatically send a TCP Emitter
// Broadcast request to the TCP Emitter server it is connected to. By doing this
// it will invoke the listeners of the event emitted of all the other connected
// clients.
clientInst.emit('new-user', [1, '2', true, { name: 'luca' }])
npm install
npm test
npm install
npm run docs
ISC
FAQs
Client for TCP Emitter Server
The npm package tcp-emitter-client receives a total of 0 weekly downloads. As such, tcp-emitter-client popularity was classified as not popular.
We found that tcp-emitter-client demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.