seisplotjs.datalink 2.0.0-alpha.4

seisplotjs.datalink

2.0.0-alpha.4

DATALINK_PROTOCOL
QUERY_MODE
STREAM_MODE
MAX_PROC_NUM
USER_BROWSER
ERROR
PACKET
STREAM
ENDSTREAM
MSEED_TYPE
DataLinkConnection ▸
- Instance members
- #url
- #packetHandler
- #errorHandler
- #closeHandler
- #serverId
- #clientIdNum
- #username
- #responseResolve
- #responseReject
- #webSocket
- #setOnClose
- #connect
- #isConnected
- #mode
- #stream
- #endStream
- #close
- #sendId
- #encodeDL
- #sendDLBinary
- #sendDLCommand
- #awaitDLBinary
- #awaitDLCommand
- #writeAck
- #handleError
DataLinkPacket ▸
- Instance members
- #header
- #data
- #streamId
- #pktid
- #hppackettime
- #hppacketstart
- #hppacketend
- #dataSize
- #_miniseed
- #packetStart
- #packetEnd
- #packetTime
- #isMiniseed
- #miniseed
momentToHPTime
hpTimeToMoment
stringToUint8Array

Need help reading this?

DATALINK_PROTOCOL

src/datalink.js

const for datalink protocol for web sockets, DataLink1.0

DATALINK_PROTOCOL

Type: string

QUERY_MODE

src/datalink.js

const for query mode, QUERY

QUERY_MODE

Type: string

STREAM_MODE

src/datalink.js

const for streaming mode, STREAM

STREAM_MODE

Type: string

MAX_PROC_NUM

src/datalink.js

const for maximum process number to create fake number for datalink id, 2^16-2

MAX_PROC_NUM

USER_BROWSER

src/datalink.js

const for fake user name for datalink id, browser

USER_BROWSER

Type: string

ERROR

src/datalink.js

const for error response, ERROR

ERROR

Type: string

PACKET

src/datalink.js

PACKET

Type: string

STREAM

src/datalink.js

STREAM

Type: string

ENDSTREAM

src/datalink.js

ENDSTREAM

Type: string

MSEED_TYPE

src/datalink.js

MSEED_TYPE

Type: string

DataLinkConnection

src/datalink.js

A websocket based Datalink connection to a ringserver. https://raw.githubusercontent.com/iris-edu/libdali/master/doc/DataLink.protocol

new DataLinkConnection(url: string, packetHandler: function (packet: DataLinkPacket): void, errorHandler: function (error: Error): void)

Parameters

url (string) websocket url to the ringserver

packetHandler (function (packet: DataLinkPacket): void) callback for packets as they arrive

errorHandler (function (error: Error): void) callback for errors

Instance Members

▸ url

src/datalink.js

url

Type: string

▸ packetHandler

src/datalink.js

packetHandler

Type: function (packet: DataLinkPacket): void

▸ errorHandler

src/datalink.js

errorHandler

Type: function (error: Error): void

▸ closeHandler

src/datalink.js

closeHandler

Type: (null | function (close: CloseEvent): void)

▸ serverId

src/datalink.js

serverId

Type: (string | null)

▸ clientIdNum

src/datalink.js

clientIdNum

Type: number

▸ username

src/datalink.js

username

Type: string

▸ responseResolve

src/datalink.js

responseResolve

Type: (null | function (response: string): void)

▸ responseReject

src/datalink.js

responseReject

Type: (null | function (error: Error): void)

▸ webSocket

src/datalink.js

webSocket

Type: (WebSocket | null)

▸ setOnClose(closeHandler)

src/datalink.js

setOnClose(closeHandler: function (close: CloseEvent): void)

Parameters

closeHandler (function (close: CloseEvent): void)

▸ connect()

src/datalink.js

creates the websocket connection and sends the client ID. Returns a Promise that resolves to the server's ID.

connect()

▸ isConnected()

src/datalink.js

isConnected(): boolean

Returns

boolean: true if the websocket is connected (non-null)

▸ mode

src/datalink.js

gets the current mode, QUERY_MODE or STREAM_MODE

mode

▸ stream()

src/datalink.js

Switches to streaming mode to receive data packets from the ringserver.

stream(): void

Returns

void

▸ endStream()

src/datalink.js

Switches back to query mode to enable commands to be sent to the ringserver.

endStream(): void

Returns

void

▸ close()

src/datalink.js

Closes the connection and the underlying websocket. No communication is possible until connect() is called again.

close(): void

Returns

void

▸ sendId()

src/datalink.js

Send a ID Command. Command is a string.

sendId(): Promise<string>

Returns

Promise<string>: a Promise that resolves to the response from the ringserver.

▸ encodeDL(command, data?)

src/datalink.js

encodes as a Datalink packet, header with optional data section as binary Uint8Array. Size of the binary data is appended to the header if present.

encodeDL(command: string, data: Uint8Array?): ArrayBuffer

Parameters

command (string)

data (Uint8Array?)

Returns

ArrayBuffer

▸ sendDLBinary(header, data?)

src/datalink.js

sends the header with optional binary data as the data section. Size of the data is appended to the header before sending if present.

sendDLBinary(header: string, data: Uint8Array?): void

Parameters

header (string) header to send

data (Uint8Array?) optional data to send

Returns

void

▸ sendDLCommand(command, dataString?)

src/datalink.js

sends the command as header with optional dataString as the data section. Size of the dataString is appended to the header before sending.

sendDLCommand(command: string, dataString: string?): void

Parameters

command (string)

dataString (string?)

Returns

void

▸ awaitDLBinary(header, data?)

src/datalink.js

Send a DataLink Command and await the response. Command is a string.

awaitDLBinary(header: string, data: Uint8Array?): Promise<string>

Parameters

header (string)

data (Uint8Array?)

Returns

Promise<string>: a Promise that resolves with the webSocket MessageEvent.

▸ awaitDLCommand(command, dataString?)

src/datalink.js

Send a DataLink Command and await the response. Command is a string. Returns a Promise that resolves with the webSocket MessageEvent.

awaitDLCommand(command: string, dataString: string?): Promise<string>

Parameters

command (string)

dataString (string?)

Returns

Promise<string>

▸ writeAck(streamid, hpdatastart, hpdataend, data?)

src/datalink.js

Writes data to the ringserver and awaits a acknowledgement.

writeAck(streamid: string, hpdatastart: number, hpdataend: number, data: Uint8Array?)

Parameters

streamid (string)

hpdatastart (number)

hpdataend (number)

data (Uint8Array?)

▸ handleError(error)

src/datalink.js

handleError(error: Error)

Parameters

error (Error)

DataLinkPacket

src/datalink.js

Represents a Datalink packet from the ringserver. Note this cannot connect directly to a native TCP socket, instead it sends the datalink protocol over a websocket. Currently only the IRIS ringserver supports websockets, but it may be possible to use thrid party tools to proxy the websocket to a TCP datalink socket.

new DataLinkPacket(header: string, dataview: DataView)

Parameters

header (string)

dataview (DataView)

Instance Members

▸ header

src/datalink.js

header

Type: string

▸ data

src/datalink.js

data