Class SerialSyncConnection

Serial protocol stack - SLP, PADP, CMP.

Hierarchy (view full)

SyncConnection<PadpStream>
- SerialSyncConnection

Index

Constructors

constructor

new SerialSyncConnection(rawStream, opts?): SerialSyncConnection
Parameters
- rawStream: Duplex
  Raw data stream underlying the DLP stream.
- opts: SerialSyncConnectionOptions = {}
Returns SerialSyncConnection
Overrides SyncConnection.constructor
- Defined in src/protocols/sync-connections.ts:225

Properties

baudRate

baudRate: number = CMP_INITIAL_BAUD_RATE

Current baud rate.

Initially set to CMP_INITIAL_BAUD_RATE, and updated to negotiated baud rate after handshake.

`Readonly`dlpConnection

dlpConnection: DlpConnection

DLP connection for communicating with the device.

`Protected` `Readonly`dlpTransportStream

dlpTransportStream: PadpStream

Transport stream for reading / writing DLP datagrams, such as a PADP or NetSync stream.

`Protected` `Readonly`log

log: Debugger = ...

Logger.

`Protected` `Readonly`opts

opts: SyncConnectionOptions = {}

`Protected` `Readonly`rawStream

rawStream: Duplex

Raw data stream underlying the DLP stream.

`Readonly`recorder

recorder: StreamRecorder = ...

Recorder for the raw stream.

Methods

`Protected`createDlpTransportStream

createDlpTransportStream(rawStream): PadpStream
Create a stream yielding DLP datagrams based on a raw data stream.
Parameters
- rawStream: Duplex
Returns PadpStream
Overrides SyncConnection.createDlpTransportStream
- Defined in src/protocols/sync-connections.ts:234

doHandshake

doHandshake(): Promise<void>
Perform initial handshake with the Palm device to00000 establish connection.

Returns Promise<void>
Overrides SyncConnection.doHandshake
- Defined in src/protocols/sync-connections.ts:237

end

end(): Promise<void>
Common DLP operations to run at the end of a HotSync session.

Returns Promise<void>
Inherited from SyncConnection.end
- Defined in src/protocols/sync-connections.ts:200

start

start(): Promise<void>
Common DLP operations to run at the start of a HotSync session.

Returns Promise<void>
Inherited from SyncConnection.start
- Defined in src/protocols/sync-connections.ts:190

Class SerialSyncConnection

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SerialSyncConnection

Properties

baudRate

`Readonly`dlpConnection

`Protected` `Readonly`dlpTransportStream

`Protected` `Readonly`log

`Protected` `Readonly`opts

`Protected` `Readonly`rawStream

`Readonly`recorder

Methods

`Protected`createDlpTransportStream

Parameters

Returns PadpStream

doHandshake

Returns Promise<void>

end

Returns Promise<void>

start

Returns Promise<void>

Settings

On This Page

Class SerialSyncConnection

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SerialSyncConnection

Properties

baudRate

ReadonlydlpConnection

Protected ReadonlydlpTransportStream

Protected Readonlylog

Protected Readonlyopts

Protected ReadonlyrawStream

Readonlyrecorder

Methods

ProtectedcreateDlpTransportStream

Parameters

Returns PadpStream

doHandshake

Returns Promise<void>

end

Returns Promise<void>

start

Returns Promise<void>

Settings

On This Page

`Readonly`dlpConnection

`Protected` `Readonly`dlpTransportStream

`Protected` `Readonly`log

`Protected` `Readonly`opts

`Protected` `Readonly`rawStream

`Readonly`recorder

`Protected`createDlpTransportStream