TelnetSpy

https://github.com/yasheena/telnetspy
Admin
TelnetSpy is an Arduino library for ESP8266 and ESP32 that enables debugging over the air by cloning...
Tokens:7,358
Snippets:100
Trust Score:5.2
License:MIT
Update:4 months ago
Show doc for...
Tokens:
Raw
### Begin TelnetSpy in Setup

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Call the begin() method of the TelnetSpy object in your setup() function to initialize the Telnet server.

```cpp
LOG.begin();
```

--------------------------------

### Set Callback for NVT AYT Command

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Installs a callback function to be executed when the Telnet 'AYT' (Are You There) command is received. Use NULL to remove the callback.

```cpp
void setCallbackOnNvtAYT(void (*callback)())
```

--------------------------------

### setCallbackOnConnect

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Installs a callback function that will be executed every time a Telnet connection is successfully established. Use NULL to remove any previously set callback.

```APIDOC
## void setCallbackOnConnect(void (*callback)())

### Description
This function installs a callback function which will be called on every Telnet connect of this object (except rejected connect tries). Use NULL to remove the callback.

### Method
void

### Parameters
#### Path Parameters
- **callback** (void (*)()) - Required - A pointer to the callback function to execute on connect, or NULL.
```

--------------------------------

### setCallbackOnNvtAYT

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

This function installs a callback function which will be called whenever the telnet command "AYT" (Are you there) is received. Use NULL to remove the callback.

```APIDOC
## setCallbackOnNvtAYT

### Description

This function installs a callback function which will be called whenever the telnet command "AYT" (Are you there) is received. Use NULL to remove the callback.

### Method

void

### Endpoint

setCallbackOnNvtAYT(void (*callback)())

### Parameters

#### Path Parameters

- **callback** (void (*)()) - Optional - The callback function to be called when AYT is received. Use NULL to remove the callback.

### Request Example

```
void handleNvtAYT() {
  // Process AYT command
}
setCallbackOnNvtAYT(handleNvtAYT);

// To remove the callback:
setCallbackOnNvtAYT(NULL);
```

### Response

None
```

--------------------------------

### Set Callback for NVT BRK Command

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Installs a callback function to be executed when the Telnet 'BRK' (Break) command is received. Use NULL to remove the callback.

```cpp
void setCallbackOnNvtBRK(void (*callback)())
```

--------------------------------

### Set Callback on Connect

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Installs a callback function to be executed upon each Telnet connection (excluding rejected attempts). Pass NULL to remove the callback. Defaults to NULL.

```cpp
void setCallbackOnConnect(void (*callback)())
```

--------------------------------

### setCallbackOnNvtGA

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

This function installs a callback function which will be called whenever the telnet command "GA" (Go Ahead) is received. Use NULL to remove the callback.

```APIDOC
## setCallbackOnNvtGA

### Description

This function installs a callback function which will be called whenever the telnet command "GA" (Go Ahead) is received. Use NULL to remove the callback.

### Method

void

### Endpoint

setCallbackOnNvtGA(void (*callback)())

### Parameters

#### Path Parameters

- **callback** (void (*)()) - Optional - The callback function to be called when GA is received. Use NULL to remove the callback.

### Request Example

```
void handleNvtGA() {
  // Process GA command
}
setCallbackOnNvtGA(handleNvtGA);

// To remove the callback:
setCallbackOnNvtGA(NULL);
```

### Response

None
```

--------------------------------

### Set Callback for NVT GA Command

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Installs a callback function to be executed when the Telnet 'GA' (Go Ahead) command is received. Use NULL to remove the callback.

```cpp
void setCallbackOnNvtGA(void (*callback)())
```

--------------------------------

### setCallbackOnDisconnect

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Installs a callback function that will be executed every time a Telnet connection is terminated. Use NULL to remove any previously set callback.

```APIDOC
## void setCallbackOnDisconnect(void (*callback)())

### Description
This function installs a callback function which will be called on every Telnet disconnect of this object (except rejected connect tries). Use NULL to remove the callback.

### Method
void

### Parameters
#### Path Parameters
- **callback** (void (*)()) - Required - A pointer to the callback function to execute on disconnect, or NULL.
```

--------------------------------

### Set Callback for NVT WWDD Commands

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Installs a callback function to be executed when Telnet commands 'WILL', 'WON\'T', 'DO', or 'DON\'T' are received. Use NULL to remove the callback.

```cpp
void setCallbackOnNvtWWDD(void (*callback)())
```

--------------------------------

### setCallbackOnNvtBRK

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

This function installs a callback function which will be called whenever the telnet command "BRK" (Break) is received. Use NULL to remove the callback.

```APIDOC
## setCallbackOnNvtBRK

### Description

This function installs a callback function which will be called whenever the telnet command "BRK" (Break) is received. Use NULL to remove the callback.

### Method

void

### Endpoint

setCallbackOnNvtBRK(void (*callback)())

### Parameters

#### Path Parameters

- **callback** (void (*)()) - Optional - The callback function to be called when BRK is received. Use NULL to remove the callback.

### Request Example

```
void handleNvtBRK() {
  // Process BRK command
}
setCallbackOnNvtBRK(handleNvtBRK);

// To remove the callback:
setCallbackOnNvtBRK(NULL);
```

### Response

None
```

--------------------------------

### Get Telnet Buffer Size

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Retrieves the current actual size of the ring buffer.

```cpp
uint16_t getBufferSize()
```

--------------------------------

### setCallbackOnNvtIP

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

This function installs a callback function which will be called whenever the telnet command "IP" (Interrupt Process) is received. Use NULL to remove the callback.

```APIDOC
## setCallbackOnNvtIP

### Description

This function installs a callback function which will be called whenever the telnet command "IP" (Interrupt Process) is received. Use NULL to remove the callback.

### Method

void

### Endpoint

setCallbackOnNvtIP(void (*callback)())

### Parameters

#### Path Parameters

- **callback** (void (*)()) - Optional - The callback function to be called when IP is received. Use NULL to remove the callback.

### Request Example

```
void handleNvtIP() {
  // Process IP command
}
setCallbackOnNvtIP(handleNvtIP);

// To remove the callback:
setCallbackOnNvtIP(NULL);
```

### Response

None
```

--------------------------------

### Get Receive Buffer Size

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Retrieves the current actual size of the receive buffer.

```cpp
uint16_t getRecBufferSize()
```

--------------------------------

### Get Store Offline State

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Retrieves the current state of whether data is being stored when offline.

```cpp
bool getStoreOffline()
```

--------------------------------

### setCallbackOnNvtAO

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

This function installs a callback function which will be called whenever the telnet command "AO" (Abort Output) is received. Use NULL to remove the callback.

```APIDOC
## setCallbackOnNvtAO

### Description

This function installs a callback function which will be called whenever the telnet command "AO" (Abort Output) is received. Use NULL to remove the callback.

### Method

void

### Endpoint

setCallbackOnNvtAO(void (*callback)())

### Parameters

#### Path Parameters

- **callback** (void (*)()) - Optional - The callback function to be called when AO is received. Use NULL to remove the callback.

### Request Example

```
void handleNvtAO() {
  // Process AO command
}
setCallbackOnNvtAO(handleNvtAO);

// To remove the callback:
setCallbackOnNvtAO(NULL);
```

### Response

None
```

--------------------------------

### Set Callback for NVT IP Command

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Installs a callback function to be executed when the Telnet 'IP' (Interrupt Process) command is received. Use NULL to remove the callback.

```cpp
void setCallbackOnNvtIP(void (*callback)())
```

--------------------------------

### Set Callback for NVT EL Command

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Installs a callback function to be executed when the Telnet 'EL' (Erase Line) command is received. Use NULL to remove the callback.

```cpp
void setCallbackOnNvtEL(void (*callback)())
```

--------------------------------

### Set Callback on Disconnect

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Installs a callback function to be executed upon each Telnet disconnection (excluding rejected connect tries). Pass NULL to remove the callback. Defaults to NULL.

```cpp
void setCallbackOnDisconnect(void (*callback)())
```

--------------------------------

### Set Callback for NVT EC Command

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Installs a callback function to be executed when the Telnet 'EC' (Erase Character) command is received. Use NULL to remove the callback.

```cpp
void setCallbackOnNvtEC(void (*callback)())
```

--------------------------------

### Set Callback for NVT AO Command

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Installs a callback function to be executed when the Telnet 'AO' (Abort Output) command is received. Use NULL to remove the callback.

```cpp
void setCallbackOnNvtAO(void (*callback)())
```

--------------------------------

### setCallbackOnNvtEC

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

This function installs a callback function which will be called whenever the telnet command "EC" (Erase Character) is received. Use NULL to remove the callback.

```APIDOC
## setCallbackOnNvtEC

### Description

This function installs a callback function which will be called whenever the telnet command "EC" (Erase Character) is received. Use NULL to remove the callback.

### Method

void

### Endpoint

setCallbackOnNvtEC(void (*callback)())

### Parameters

#### Path Parameters

- **callback** (void (*)()) - Optional - The callback function to be called when EC is received. Use NULL to remove the callback.

### Request Example

```
void handleNvtEC() {
  // Process EC command
}
setCallbackOnNvtEC(handleNvtEC);

// To remove the callback:
setCallbackOnNvtEC(NULL);
```

### Response

None
```

--------------------------------

### setCallbackOnNvtWWDD

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

This function installs a callback function which will be called whenever the telnet commands "WILL", "WON'T", "DO" or "DON'T" are received. Use NULL to remove the callback.

```APIDOC
## setCallbackOnNvtWWDD

### Description

This function installs a callback function which will be called whenever the telnet commands "WILL", "WON'T", "DO" or "DON'T" are received. Use NULL to remove the callback.

### Method

void

### Endpoint

setCallbackOnNvtWWDD(void (*callback)())

### Parameters

#### Path Parameters

- **callback** (void (*)()) - Optional - The callback function to be called when WILL, WON'T, DO, or DON'T are received. Use NULL to remove the callback.

### Request Example

```
void handleNvtWWDD() {
  // Process WWDD command
}
setCallbackOnNvtWWDD(handleNvtWWDD);

// To remove the callback:
setCallbackOnNvtWWDD(NULL);
```

### Response

None
```

--------------------------------

### setCallbackOnNvtEL

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

This function installs a callback function which will be called whenever the telnet command "EL" (Erase Line) is received. Use NULL to remove the callback.

```APIDOC
## setCallbackOnNvtEL

### Description

This function installs a callback function which will be called whenever the telnet command "EL" (Erase Line) is received. Use NULL to remove the callback.

### Method

void

### Endpoint

setCallbackOnNvtEL(void (*callback)())

### Parameters

#### Path Parameters

- **callback** (void (*)()) - Optional - The callback function to be called when EL is received. Use NULL to remove the callback.

### Request Example

```
void handleNvtEL() {
  // Process EL command
}
setCallbackOnNvtEL(handleNvtEL);

// To remove the callback:
setCallbackOnNvtEL(NULL);
```

### Response

None
```

--------------------------------

### Get Filter Character

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Retrieves the currently set filter character. Returns 0 if no filter is active.

```cpp
char getFilter()
```

--------------------------------

### Begin Telnet Server Connection

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

To connect to the Telnet server, establish a WiFi connection and then execute this command. The order of these steps is not important.

```cpp
SerialAndTelnet.begin(WhatEverYouWant)
```

--------------------------------

### Include TelnetSpy and Initialize Object

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Include the TelnetSpy library and create an instance of the TelnetSpy object in your sketch.

```cpp
#include <TelnetSpy.h>
TelnetSpy LOG;
```

--------------------------------

### TelnetSpy Initialization Hint

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Add these lines to your sketch to initialize TelnetSpy and optionally redirect serial output to Telnet. Replace 'Serial' with 'SERIAL' in your sketch to switch.

```cpp
TelnetSpy SerialAndTelnet;
#define SERIAL SerialAndTelnet
// #define SERIAL Serial
```

--------------------------------

### Set Custom Welcome Message

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Customize the message sent to the Telnet client upon connection establishment.

```cpp
void setWelcomeMsg(const char* msg)
void setWelcomeMsg(const String& msg)
```

--------------------------------

### Configure TelnetSpy Buffer Length

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

If you encounter low memory issues, you can reduce the size of the ring buffer by modifying this define during initialization.

```cpp
#define TELNETSPY_BUFFER_LEN
```

--------------------------------

### Set Collecting Time for Small Telnet Blocks

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Adjusts the time in milliseconds to wait before sending a Telnet block if its size is less than the minimum defined by setMinBlockSize. The default is 100ms.

```cpp
void setCollectingTime(uint16_t colTime)
```

--------------------------------

### setPingTime

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Sets the time in milliseconds after which a ping (chr(0)) is sent to the Telnet client to detect a disconnected client earlier when no data is being transmitted. Setting this to 0 disables pings.

```APIDOC
## void setPingTime(uint16_t pngTime)

### Description
If no data is sent via TelnetSpy, the detection of a disconnected client has a long timeout. Use setPingTime to define the time (in ms) without traffic after which a ping aka a chr(0) is sent to the Telnet client to detect a disconnect earlier. Use 0 as parameter to disable pings.

### Method
void

### Parameters
#### Path Parameters
- **pngTime** (uint16_t) - Required - The time in milliseconds for ping interval. Use 0 to disable.
```

--------------------------------

### setBufferSize

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Changes the size of the internal ring buffer. Setting it to 0 disables buffering, which affects debug output handling. The function attempts to preserve existing data, but may only keep the latest data if the new size is too small. Returns false if the size cannot be set.

```APIDOC
## bool setBufferSize(uint16_t newSize)

### Description
Changes the size of the ring buffer. Set it to 0 to disable buffering. Changing size tries to preserve the already collected data. Returns false if the requested buffer size cannot be set.

### Method
bool

### Parameters
#### Path Parameters
- **newSize** (uint16_t) - Required - The new size for the ring buffer. Use 0 to disable.
```

--------------------------------

### Set Telnet Buffer Size

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Changes the size of the ring buffer. Setting it to 0 disables buffering, which means debug output will only go to serial. This function attempts to preserve existing data, but if the new size is too small, only the latest data will be kept. Returns false if the buffer size cannot be set. Default is 3000.

```cpp
bool setBufferSize(uint16_t newSize)
```

--------------------------------

### Check Telnet Client Connection

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Returns true if a Telnet client is currently connected.

```cpp
bool isClientConnected()
```

--------------------------------

### Handle Telnet Connections in Loop

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Call the handle() method of the TelnetSpy object in your loop() function to manage Telnet connections and data.

```cpp
LOG.handle();
```

--------------------------------

### getStoreOffline

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Retrieves the current status of whether data is being stored in the ring buffer when no Telnet connection is established.

```APIDOC
## bool getStoreOffline()

### Description
Get actual state of storing data when offline.

### Method
bool
```

--------------------------------

### setStoreOffline

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Enables or disables the storage of new data in the ring buffer when no Telnet connection is active. This allows selective storage of important data.

```APIDOC
## void setStoreOffline(bool store)

### Description
Enable / disable storing new data in the ring buffer if no Telnet connection is established.

### Method
void

### Parameters
#### Path Parameters
- **store** (bool) - Required - True to enable storing offline, false to disable.
```

--------------------------------

### Set Telnet Reject Message

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Changes the message sent to a Telnet client if another session is already established. Defaults to 'TelnetSpy: Only one connection possible.\n'.

```cpp
void setRejectMsg(const char* msg)
void setRejectMsg(const String& msg)
```

--------------------------------

### Set Receive Buffer Size

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Changes the size of the receive buffer. Setting it to 0 disables buffering within TelnetSpy, relying on the underlying WifiClient buffer. Returns false if the size cannot be set. If the buffer is full, received data may be lost, and NVT protocol handling might be affected. Default is 64.

```cpp
bool setRecBufferSize(uint16_t newSize);
```

--------------------------------

### getBufferSize

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Retrieves the current actual size of the ring buffer.

```APIDOC
## uint16_t getBufferSize()

### Description
This function returns the actual size of the ring buffer.

### Method
uint16_t
```

--------------------------------

### Set Minimum Block Size for Telnet Data

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Modifies the number of characters to collect before sending a Telnet block. The default is 64.

```cpp
void setMinBlockSize(uint16_t minSize)
```

--------------------------------

### setSerial

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Specifies the HardwareSerial port to be used with this TelnetSpy object, particularly for platforms like ESP32. Pass NULL to disable serial port usage and rely solely on Telnet.

```APIDOC
## void setSerial(HardwareSerial* usedSerial)

### Description
Set the serial port you want to use with this object (especially for ESP32) or NULL if no serial port should be used (Telnet only).

### Method
void

### Parameters
#### Path Parameters
- **usedSerial** (HardwareSerial*) - Required - A pointer to the HardwareSerial object to use, or NULL.
```

--------------------------------

### Set Telnet Ping Time

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Defines the time in milliseconds without traffic after which a ping (chr(0)) is sent to detect a disconnected client earlier. Setting this to 0 disables pings. Default is 1500ms.

```cpp
void setPingTime(uint16_t pngTime)
```

--------------------------------

### Set Maximum Telnet Packet Size

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Configures the maximum size of Telnet packets to be sent. The default is 512.

```cpp
void setMaxBlockSize(uint16_t maxSize)
```

--------------------------------

### Set Serial Port

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Specifies the HardwareSerial port to use with TelnetSpy, particularly for ESP32. Pass NULL to use Telnet only. Defaults to Serial.

```cpp
void setSerial(HardwareSerial* usedSerial)
```

--------------------------------

### Set Store Offline State

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Enables or disables storing new data in the ring buffer when no Telnet connection is established. This is useful for selectively storing important data. Defaults to true.

```cpp
void setStoreOffline(bool store)
```

--------------------------------

### getRecBufferSize

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Returns the current actual size of the receive buffer.

```APIDOC
## uint16_t getRecBufferSize()

### Description
This function returns the actual size of the receive buffer.

### Method
uint16_t
```

--------------------------------

### Control Debug Output with Multiple Instances

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Use this function to enable or disable the capturing of os_print calls when you have multiple TelnetSpy instances. The last instance where setDebugOutput was called will manage this functionality. By default, capturing is enabled.

```cpp
void setDebugOutput(bool)
```

--------------------------------

### Set Custom Telnet Port

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Change the port number for the Telnet server. This will disconnect any active client.

```cpp
void setPort(uint16_t portToUse)
```

--------------------------------

### setCollectingTime

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Adjusts the time in milliseconds to wait before sending a Telnet block if its size is less than the minimum defined by setMinBlockSize. This helps manage small data transmissions.

```APIDOC
## void setCollectingTime(uint16_t colTime)

### Description
Changes the time (in ms) to wait before sending a Telnet block if its size is less than minSize.

### Method
void

### Parameters
#### Path Parameters
- **colTime** (uint16_t) - Required - The time in milliseconds to wait.
```

--------------------------------

### setRecBufferSize

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Changes the size of the receive buffer. Setting it to 0 disables buffering within TelnetSpy, relying on the underlying WifiClient buffer. If the buffer is full, data may be lost. Returns false if the size cannot be set.

```APIDOC
## bool setRecBufferSize(uint16_t newSize)

### Description
Changes the size of the receive buffer. Set it to 0 to disable buffering in TelnetSpy. Returns false if the requested buffer size cannot be set.

### Method
bool

### Parameters
#### Path Parameters
- **newSize** (uint16_t) - Required - The new size for the receive buffer. Use 0 to disable.
```

--------------------------------

### isClientConnected

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Checks and returns a boolean value indicating whether a Telnet client is currently connected.

```APIDOC
## bool isClientConnected()

### Description
This function returns true if a Telnet client is connected.

### Method
bool
```

--------------------------------

### setFilter

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

This function allows to filter the character given by "ch" out of the receiving telnet data stream. If this character is detected, the following happens: If a "msg" is given (not NULL), this message will be send back via the telnet connection. If the "callback" is set (not NULL), the given function is called.

```APIDOC
## setFilter

### Description

This function allows to filter the character given by "ch" out of the receiving telnet data stream. If this character is detected, the following happens:
- If a "msg" is given (not NULL), this message will be send back via the telnet connection.
- If the "callback" is set (not NULL), the given function is called.

### Method

void

### Endpoint

setFilter(char ch, const char* msg, void (*callback)())
setFilter(char ch, const String& msg, void (*callback)())

### Parameters

#### Path Parameters

- **ch** (char) - Required - The character to filter.
- **msg** (const char* or String&) - Optional - The message to send back if the character is detected.
- **callback** (void (*)()) - Optional - The function to call if the character is detected.

### Request Example

```
// Example with message
setFilter('X', "Invalid character detected!", NULL);

// Example with callback
void myFilterCallback() {
  // Handle filter event
}
setFilter('Y', NULL, myFilterCallback);
```

### Response

None
```

--------------------------------

### setMaxBlockSize

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Sets the maximum size for Telnet packets that will be sent. This controls the upper limit of data in each transmission packet.

```APIDOC
## void setMaxBlockSize(uint16_t maxSize)

### Description
Changes the maximum size of the Telnet packets to send.

### Method
void

### Parameters
#### Path Parameters
- **maxSize** (uint16_t) - Required - The maximum packet size.
```

--------------------------------

### Disconnect Telnet Client

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Call this function to terminate an active client connection.

```cpp
void disconnectClient()
```

--------------------------------

### Set Character Filter with Message and Callback

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Filters a specific character from the incoming Telnet stream. Optionally sends a message or executes a callback function when the character is detected.

```cpp
void setFilter(char ch, const char* msg, void (*callback()))
```

```cpp
void setFilter(char ch, const String& msg, void (*callback()))
```

--------------------------------

### disconnectClient

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

This function disconnects an active client connection.

```APIDOC
## disconnectClient

### Description

This function disconnects an active client connection.

### Method

void

### Endpoint

disconnectClient()

### Parameters

None

### Request Example

```
disconnectClient()
```

### Response

None
```

--------------------------------

### setMinBlockSize

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Modifies the number of characters to collect before sending a Telnet block. This affects how data is chunked for transmission.

```APIDOC
## void setMinBlockSize(uint16_t minSize)

### Description
Changes the amount of characters to collect before sending a Telnet block.

### Method
void

### Parameters
#### Path Parameters
- **minSize** (uint16_t) - Required - The minimum number of characters to collect.
```

--------------------------------

### getFilter

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

This function returns the actual filter character (0 => not set).

```APIDOC
## getFilter

### Description

This function returns the actual filter character (0 => not set).

### Method

char

### Endpoint

getFilter()

### Parameters

None

### Request Example

```
char filterChar = getFilter();
```

### Response

#### Success Response (char)

- **return value** (char) - The filter character. Returns 0 if no filter is set.
```

--------------------------------

### setRejectMsg

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Changes the message sent to a Telnet client if another session is already established. This function can accept a C-style string or a String object.

```APIDOC
## void setRejectMsg(const char* msg)
## void setRejectMsg(const String& msg)

### Description
Changes the message that will be sent to the Telnet client if another session is already established.

### Method
void

### Parameters
#### Path Parameters
- **msg** (const char* or const String&) - Required - The rejection message string.
```

--------------------------------

### Clear Telnet Buffer

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

Clears the transmit buffer, discarding all pending data to be sent over the Telnet connection.

```cpp
void clearBuffer()
```

--------------------------------

### clearBuffer

Source: https://github.com/yasheena/telnetspy/blob/master/README.md

This function clears the transmit buffer of TelnetSpy, so all waiting data to send via a telnet connection will be discard.

```APIDOC
## clearBuffer

### Description

This function clears the transmit buffer of TelnetSpy, so all waiting data to send via a telnet connection will be discard.

### Method

void

### Endpoint

clearBuffer()

### Parameters

None

### Request Example

```
clearBuffer()
```

### Response

None
```
Tokens:
Raw