chore(release): 5.3.0 [skip ci]

# [5.3.0](v5.2.1...v5.3.0) (2021-08-27)

### Features

* Implement backpressure handling ([#115](#115)) ([8a90f32](8a90f32))

Author: semantic-release-bot

CHANGELOG.md

@@ -1,3 +1,10 @@
+# [5.3.0](https://github.com/Rapsssito/react-native-tcp-socket/compare/v5.2.1...v5.3.0) (2021-08-27)
+
+
+### Features
+
+* Implement backpressure handling ([#115](https://github.com/Rapsssito/react-native-tcp-socket/issues/115)) ([8a90f32](https://github.com/Rapsssito/react-native-tcp-socket/commit/8a90f32077417f0a2bb9d349470d078366e4fc6c))
+
 ## [5.2.1](https://github.com/Rapsssito/react-native-tcp-socket/compare/v5.2.0...v5.2.1) (2021-06-09)
 
 

coverage/coverage-final.json

@@ -1,7 +1,13 @@
 /**
- * @extends {EventEmitter<'connection' | 'listening' | 'error' | 'close', any>}
+ * @typedef {object} ServerEvents
+ * @property {() => void} close
+ * @property {(socket: Socket) => void} connection
+ * @property {() => void} listening
+ * @property {(err: Error) => void} error
+ *
+ * @extends {EventEmitter<ServerEvents, any>}
  */
-export default class Server extends EventEmitter<"error" | "close" | "connection" | "listening", any> {
+export default class Server extends EventEmitter<ServerEvents, any> {
     /**
      * @param {(socket: Socket) => void} [connectionCallback] Automatically set as a listener for the `'connection'` event.
      */
@@ -84,5 +90,11 @@ export default class Server extends EventEmitter<"error" | "close" | "connection
      */
     private _buildSocket;
 }
+export type ServerEvents = {
+    close: () => void;
+    connection: (socket: Socket) => void;
+    listening: () => void;
+    error: (err: Error) => void;
+};
 import EventEmitter from "eventemitter3";
 import Socket from "./Socket";

lib/types/Server.d.ts

@@ -20,13 +20,27 @@
  * tlsCert?: any,
  * }} ConnectionOptions
  *
- * @extends {EventEmitter<'connect' | 'timeout' | 'data' | 'error' | 'close', any>}
+ * @typedef {object} ReadableEvents
+ * @property {() => void} pause
+ * @property {() => void} resume
+ *
+ * @typedef {object} SocketEvents
+ * @property {(had_error: boolean) => void} close
+ * @property {() => void} connect
+ * @property {(data: Buffer | string) => void} data
+ * @property {() => void} drain
+ * @property {(err: Error) => void} error
+ * @property {() => void} timeout
+ *
+ * @extends {EventEmitter<SocketEvents & ReadableEvents, any>}
  */
-export default class Socket extends EventEmitter<"connect" | "timeout" | "data" | "error" | "close", any> {
+export default class Socket extends EventEmitter<SocketEvents & ReadableEvents, any> {
     /** @private */
     private _id;
     /** @private */
     private _eventEmitter;
+    /** @type {EventEmitter<'written', any>} @private */
+    private _msgEvtEmitter;
     /** @type {number} @private */
     private _timeoutMsecs;
     /** @private */
@@ -35,6 +49,24 @@ export default class Socket extends EventEmitter<"connect" | "timeout" | "data"
     private _state;
     /** @private */
     private _encoding;
+    /** @private */
+    private _msgId;
+    /** @private */
+    private _lastRcvMsgId;
+    /** @private */
+    private _lastSentMsgId;
+    /** @private */
+    private _paused;
+    /** @private */
+    private _resuming;
+    /** @private */
+    private _writeBufferSize;
+    /** @type {{ id: number; data: string; }[]} @private */
+    private _pausedDataEvents;
+    readableHighWaterMark: number;
+    writableHighWaterMark: number;
+    writableNeedDrain: boolean;
+    bytesSent: number;
     localAddress: string | undefined;
     localPort: number | undefined;
     remoteAddress: string | undefined;
@@ -124,15 +156,36 @@ export default class Socket extends EventEmitter<"connect" | "timeout" | "data"
     /**
      * Sends data on the socket. The second parameter specifies the encoding in the case of a string — it defaults to UTF8 encoding.
      *
+     * Returns `true` if the entire data was flushed successfully to the kernel buffer. Returns `false` if all or part of the data
+     * was queued in user memory. `'drain'` will be emitted when the buffer is again free.
+     *
      * The optional callback parameter will be executed when the data is finally written out, which may not be immediately.
      *
      * @param {string | Buffer | Uint8Array} buffer
      * @param {BufferEncoding} [encoding]
-     * @param {(error: string | null) => void} [callback]
+     * @param {(err?: Error) => void} [cb]
+     *
+     * @return {boolean}
+     */
+    write(buffer: string | Buffer | Uint8Array, encoding?: "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex" | undefined, cb?: ((err?: Error | undefined) => void) | undefined): boolean;
+    /**
+     * Pauses the reading of data. That is, `'data'` events will not be emitted. Useful to throttle back an upload.
+     */
+    pause(): void;
+    /**
+     * Resumes reading after a call to `socket.pause()`.
      */
-    write(buffer: string | Buffer | Uint8Array, encoding?: "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex" | undefined, callback?: ((error: string | null) => void) | undefined): void;
+    resume(): void;
     ref(): void;
     unref(): void;
+    /**
+     * @private
+     */
+    private _recoverDataEventsAfterPause;
+    /**
+     * @private
+     */
+    private _onDeviceDataEvt;
     /**
      * @private
      */
@@ -141,6 +194,7 @@ export default class Socket extends EventEmitter<"connect" | "timeout" | "data"
     _errorListener: import("react-native").EmitterSubscription | undefined;
     _closeListener: import("react-native").EmitterSubscription | undefined;
     _connectListener: import("react-native").EmitterSubscription | undefined;
+    _writtenListener: import("react-native").EmitterSubscription | undefined;
     /**
      * @private
      */
@@ -182,5 +236,17 @@ export type ConnectionOptions = {
     tlsCheckValidity?: boolean | undefined;
     tlsCert?: any;
 };
+export type ReadableEvents = {
+    pause: () => void;
+    resume: () => void;
+};
+export type SocketEvents = {
+    close: (had_error: boolean) => void;
+    connect: () => void;
+    data: (data: Buffer | string) => void;
+    drain: () => void;
+    error: (err: Error) => void;
+    timeout: () => void;
+};
 import EventEmitter from "eventemitter3";
 import { Buffer } from "buffer";

lib/types/Socket.d.ts

@@ -1,7 +1,7 @@
 {
   "name": "react-native-tcp-socket",
   "title": "React Native Tcp Socket",
-  "version": "5.2.1",
+  "version": "5.3.0",
   "description": "React Native TCP socket API for Android & iOS with SSL/TLS support",
   "main": "src/index.js",
   "types": "lib/types/index.d.ts",