Nicely Pruned Marigolds

    @thegraid/wspbserver
    TypeScript icon, indicating that this package has built-in type declarations

    1.5.23 • Public • Published

    wspbserver

    WebSocketProtoBufServer: managing client-group connections, passing messages between clients.

    wspbserver is basically a 'chatroom' server for websocket/protobuf applications.

    The Client-Group protocol (CgProto, from wsbpclient) has commands to Join, Leave, Send & Ack/Nak.

    client apps join a group, get a client_id (~ the socket-id) and can then post messages to the group, and recieve copies of messages that other clients send. Messages are 'flow-controlled' by requiring an ACK from each client before proceeding to the next message, so clients stay synch'd.

    Send forwards the payload (bytearray, presumably a protobuf for an inner protocol) to the Referee, and if the Referee ACKs it, then to the other members of the group (including the sender, unless nocc == true). The CgMessage contains other 'envelope' and message status info.

    Each Group gets an implicit "group moderator" (or Referee) that ACK's all requests. This is replaced by an actual Referee app when such an app joins and declares itself to be the Referee. Such a Referee can enforce game rules & validate common state among clients.

    Install

    npm i @thegraid/wspbserver

    DownloadsWeekly Downloads

    29

    Version

    1.5.23

    License

    ISC

    Unpacked Size

    73.3 kB

    Total Files

    20

    Last publish

    Collaborators

    • thegraid