rxprotoplex v1.2.5

Plex Utilities

This library provides RxJS utilities for working with Plex-based connections and streams, enabling functionalities such as encoding configuration, multiplexing, event handling, and data transmission.

Installation

To install the library, run the following command:

npm install rxprotoplex

Overview of Functions

asPlex

Wraps a given stream in a Protoplex instance if it is not already multiplexed.

const plexStream = asPlex(stream, { someConfig: true });
console.log(plexStream); // Outputs either the original multiplexed stream or a new Protoplex instance

connection$

Creates an RxJS Observable that listens for connection events on a specified Plex instance, optionally filtered by channel ID and protocol. The Observable automatically completes when the Plex instance emits a "close" event.

connection$(plexInstance, "channelId", { protocol: "myProtocol" }).subscribe(connection => {
  console.log("New connection event:", connection);
});

Note: onConnection$ is deprecated. Use connection$ instead.

connectionAndRead$

Creates an RxJS Observable that listens for connection events on a specified Plex instance, filters connections based on channel ID and protocol if specified, consumes the stream data, and completes automatically when the Plex instance emits a "close" event.

connectionAndRead$(plexInstance, "channelId", { protocol: "myProtocol" }).subscribe(event => {
  console.log("Received data:", event.data);
  console.log("Stream ID:", event.id);
  console.log("Protocol:", event.protocol);
});

Note: onConnectionAndRead$ is deprecated. Use connectionAndRead$ instead.

connectAndSend

Establishes a one-time connection to a specified Plex channel, sends data, and then closes the connection.

const sendData = connectAndSend(plexInstance, "channelId", { encoding: "utf-8" });
sendData("Hello, World!");

Note: sendOnce is deprecated. Use connectAndSend instead.

consumePlexStream

An RxJS operator that consumes a Plex stream, transforming each data event into an object containing metadata.

source$.pipe(consumePlexStream).subscribe(event => {
  console.log("Received data:", event.data);
  console.log("Stream ID:", event.id);
  console.log("Protocol:", event.protocol);
});

createPlexPair

Creates a pair of Plex instances using the provided configuration.

const plexPair = createPlexPair({ bits: 256, keyPair: myKeyPair });
console.log("Plex Pair:", plexPair); // Array of two connected Plex instances

listenAndConnection$

Listens for incoming connections on a specified channel and returns an RxJS Observable for connection events.

listenAndConnection$(plexInstance, "channelId", { protocol: "myProtocol" }).subscribe(connection => {
  console.log("New connection:", connection);
});

listenAndConnectionAndRead$

Listens for incoming connections on a specified channel and consumes the connection stream, providing an Observable that emits data from the connections.

listenAndConnectionAndRead$(plexInstance, "channelId", { protocol: "myProtocol" }).subscribe(event => {
  console.log("Received data:", event.data);
  console.log("Stream ID:", event.id);
  console.log("Protocol:", event.protocol);
});

ofChannel

Creates an RxJS operator that filters Plex streams based on a specified channel ID and protocol, logging matching streams.

source$.pipe(ofChannel({ id: "myChannel", protocol: "myProtocol" })).subscribe(filteredStream => {
  console.log("Filtered stream:", filteredStream);
});

tapSend

Creates an RxJS operator that sends data to a specified Plex channel as a side effect and passes the data through.

source$.pipe(tapSend(plexInstance, "myChannel", { encoding: "utf-8" })).subscribe();

withEncoding

Creates a new configuration object with the specified encoding, merging it with an existing Plex configuration.

const config = withEncoding("utf-8", { protocol: "myProtocol" });
console.log(config); // { protocol: "myProtocol", encoding: <resolved utf-8 encoding> }

withHandshake

Merges handshake-related configuration properties into an existing Plex configuration.

const config = withHandshake({ handshake: "init", handshakeEncoding: "utf-8" }, { protocol: "myProtocol" });
console.log(config); // { protocol: "myProtocol", handshake: "init", handshakeEncoding: <resolved utf-8 encoding> }

withPlex

Temporarily sets the current Plex instance for the duration of an asynchronous callback, restoring the previous instance afterward.

await withPlex(newPlexInstance, async () => {
  // Perform actions with newPlexInstance as the current Plex
});

License

This project is licensed under the MIT License. See the LICENSE file for details.