seisplotjs 3.0.0-alpha.1

seisplotjs

3.0.0-alpha.1

DATALINK_PROTOCOL
MODE
QUERY_MODE
STREAM_MODE
MAX_PROC_NUM
USER_BROWSER
DEFAULT_PROGRAM
DEFAULT_ARCH
ERROR
PACKET
STREAM
ENDSTREAM
MSEED_TYPE
MSEED3_TYPE
IRIS_RINGSERVER_URL
DataLinkConnection ▸
- Static members
- .ensureDataLinkResponse
- .ensureDataLinkPacket
- Instance members
- #url
- #packetHandler
- #errorHandler
- #closeHandler
- #serverId
- #clientIdNum
- #programname
- #username
- #architecture
- #webSocket
- #setOnClose
- #connect
- #isConnected
- #mode
- #stream
- #endStream
- #close
- #sendId
- #encodeDL
- #sendDLBinary
- #sendDLCommand
- #awaitDLBinary
- #awaitDLCommand
- #writeAck
- #id
- #info
- #positionAfter
- #positionAfterHPTime
- #match
- #reject
- #read
DataLinkResponse ▸
- Static members
- .parse
- Instance members
- #type
- #value
- #message
- #toString
DataLinkPacket ▸
- Instance members
- #header
- #data
- #streamId
- #pktid
- #hppackettime
- #hppacketstart
- #hppacketend
- #dataSize
- #_miniseed
- #_mseed3
- #packetStart
- #packetEnd
- #packetTime
- #isMiniseed
- #asMiniseed
- #isMiniseed3
- #asMiniseed3
dateTimeToHPTime
hpTimeToMoment
stringToUint8Array

Need help reading this?

DATALINK_PROTOCOL

src/datalink.ts

const for datalink protocol for web sockets, DataLink1.0

DATALINK_PROTOCOL

Type: string

MODE

src/datalink.ts

enum for modes, either QUERY or STREAM

MODE

QUERY_MODE

src/datalink.ts

const for query mode, QUERY

QUERY_MODE

STREAM_MODE

src/datalink.ts

const for streaming mode, STREAM

STREAM_MODE

MAX_PROC_NUM

src/datalink.ts

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

MAX_PROC_NUM

USER_BROWSER

src/datalink.ts

const for fake user name for datalink id, browser

USER_BROWSER

Type: string

DEFAULT_PROGRAM

src/datalink.ts

const for fake program name for datalink id, seisplotjs

DEFAULT_PROGRAM

Type: string

DEFAULT_ARCH

src/datalink.ts

const for fake architecture for datalink id, javascript

DEFAULT_ARCH

Type: string

ERROR

src/datalink.ts

const for error response, ERROR

ERROR

Type: string

PACKET

src/datalink.ts

PACKET

Type: string

STREAM

src/datalink.ts

STREAM

Type: string

ENDSTREAM

src/datalink.ts

ENDSTREAM

Type: string

MSEED_TYPE

src/datalink.ts

MSEED_TYPE

Type: string

MSEED3_TYPE

src/datalink.ts

MSEED3_TYPE

Type: string

IRIS_RINGSERVER_URL

src/datalink.ts

IRIS_RINGSERVER_URL

Type: string

DataLinkConnection

src/datalink.ts

A websocket based Datalink connection.

Note this cannot connect directly to a native TCP socket, instead it sends the datalink protocol over a websocket.

Currently only the IRIS ringserver, https://github.com/iris-edu/ringserver, supports websockets, but it may be possible to use thrid party tools to proxy the websocket to a TCP datalink socket.

The datalink protocol is documented here 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

Static Members

▸ ensureDataLinkResponse(dl)

src/datalink.ts

Makes sure a response actually is a DataLinkResponse

ensureDataLinkResponse(dl: (DataLinkResponse | DataLinkPacket)): DataLinkResponse

Parameters

dl ((DataLinkResponse | DataLinkPacket)) datalink packet/response

Returns

DataLinkResponse: DataLinkResponse after checking instanceof

Throws

any: Error if not a DataLinkResponse

▸ ensureDataLinkPacket(dl)

src/datalink.ts

Makes sure a response actually is a DataLinkPacket

ensureDataLinkPacket(dl: (DataLinkResponse | DataLinkPacket)): DataLinkPacket

Parameters

dl ((DataLinkResponse | DataLinkPacket)) datalink packet/response

Returns

DataLinkPacket: DataLinkPacket after checking instanceof

Throws

any: Error if not a DataLinkPacket

Instance Members

▸ url

src/datalink.ts

url

Type: string

▸ packetHandler

src/datalink.ts

packetHandler

Type: function (packet: DataLinkPacket): void

▸ errorHandler

src/datalink.ts

errorHandler

Type: function (error: Error): void

▸ closeHandler

src/datalink.ts

closeHandler

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

▸ serverId

src/datalink.ts

serverId

Type: (string | null)

▸ clientIdNum

src/datalink.ts

clientIdNum

Type: number

▸ programname

src/datalink.ts

programname

Type: string

▸ username

src/datalink.ts

username

Type: string

▸ architecture

src/datalink.ts

architecture

Type: string

▸ webSocket

src/datalink.ts

webSocket

Type: (WebSocket | null)

▸ setOnClose(closeHandler)

src/datalink.ts

Set a callback function called when the connection is closed.

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

Parameters

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

▸ connect()

src/datalink.ts

creates the websocket connection and sends the client ID.

connect(): Promise<string>

Returns

Promise<string>: a Promise that resolves to the server's ID.

▸ isConnected()

src/datalink.ts

isConnected(): boolean

Returns

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

▸ mode

src/datalink.ts

mode

Type: string

Returns

string: the current mode, QUERY_MODE or STREAM_MODE

▸ stream()

src/datalink.ts

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

stream(): void

Returns

void

▸ endStream()

src/datalink.ts

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

endStream(): void

Returns

void

▸ close()

src/datalink.ts

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

close(): void

Returns

void

▸ sendId()

src/datalink.ts

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(header, data?)

src/datalink.ts

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(header: string, data: Uint8Array?): ArrayBuffer

Parameters

header (string) the command/header string

data (Uint8Array?) optional data portion

Returns

ArrayBuffer: datalink packet as an ArrayBuffer

▸ sendDLBinary(header, data?)

src/datalink.ts

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.ts

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) the command/header string

dataString (string?) optional data portion of packet

Returns

void

▸ awaitDLBinary(header, data?)

src/datalink.ts

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

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

Parameters

header (string) packet header

data (Uint8Array?) optional data portion of packet

Returns

Promise<(DataLinkResponse | DataLinkPacket)>: a Promise that resolves with the webSocket MessageEvent.

▸ awaitDLCommand(command, dataString?)

src/datalink.ts

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<(DataLinkResponse | DataLinkPacket)>

Parameters

command (string) the command/header string

dataString (string?) optional data portion of packet

Returns

Promise<(DataLinkResponse | DataLinkPacket)>: promise to server's response

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

src/datalink.ts

Writes data to the ringserver and awaits a acknowledgement.

writeAck(streamid: string, hpdatastart: DateTime, hpdataend: DateTime, data: Uint8Array?): Promise<(DataLinkResponse | DataLinkPacket)>

Parameters

streamid (string) stream id for packet header

hpdatastart (DateTime) start of timewindow the packet covers

hpdataend (DateTime) end of timewindow the packet covers

data (Uint8Array?) optional data to send

Returns

Promise<(DataLinkResponse | DataLinkPacket)>: promise to server's response

▸ id(programname, username, processid, architecture)

src/datalink.ts

Send id and await server's response. All of these are can more or less be filled with dummy values. They are mostly used for logging and debugging on the server side.

id(programname: string, username: string, processid: string, architecture: string): Promise<DataLinkResponse>

Parameters

programname (string) name of program, ex seisplotjs

username (string) name of user, ex browser

processid (string) process number, used to differentiate between multiple running instances

architecture (string) cpu architecture, ex javascript

Returns

Promise<DataLinkResponse>: promise to servers response

▸ info(infoType)

src/datalink.ts

Send info command for infoType.

info(infoType: string): Promise<DataLinkResponse>

Parameters

infoType (string) type to get info for

Returns

Promise<DataLinkResponse>: promise to server's response

▸ positionAfter(time)

src/datalink.ts

Send position after command.

positionAfter(time: DateTime): Promise<DataLinkResponse>

Parameters

time (DateTime) time to position after

Returns

Promise<DataLinkResponse>: promise to server's response

▸ positionAfterHPTime(hpTime)

src/datalink.ts

Send position after command.

positionAfterHPTime(hpTime: number): Promise<DataLinkResponse>

Parameters

hpTime (number) time to position after

Returns

Promise<DataLinkResponse>: promise to server's response

▸ match(pattern)

src/datalink.ts

Send match command.

match(pattern: string): Promise<DataLinkResponse>

Parameters

pattern (string) regular expression to match streams

Returns

Promise<DataLinkResponse>: promise to server's response

▸ reject(pattern)

src/datalink.ts

Send reject command.

reject(pattern: string): Promise<DataLinkResponse>

Parameters

pattern (string) regular expression to reject streams

Returns

Promise<DataLinkResponse>: promise to server's response

▸ read(packetId)

src/datalink.ts

Read a single packet for the given id.

read(packetId: string): Promise<DataLinkPacket>

Parameters

packetId (string) id of the packet of interest

Returns

Promise<DataLinkPacket>: promise to server's response

DataLinkResponse

src/datalink.ts

Datalink response, used for ID, INFO, OK and ERROR responses.

new DataLinkResponse(type: string, value: string, message: string)

Parameters

type (string)

value (string)

message (string)

Static Members

▸ parse(header, data?)

src/datalink.ts

parse(header: string, data: DataView?): DataLinkResponse

Parameters

header (string)

data (DataView?)

Returns

DataLinkResponse

Instance Members

▸ type

src/datalink.ts

type

Type: string

▸ value

src/datalink.ts

value

Type: string

▸ message

src/datalink.ts

message

Type: string

▸ toString()

src/datalink.ts

toString(): string

Returns

string

DataLinkPacket

src/datalink.ts

Represents a Datalink packet from the ringserver.

new DataLinkPacket(header: string, dataview: DataView)

Parameters

header (string)

dataview (DataView)

Instance Members

▸ header

src/datalink.ts

header

Type: string

▸ data

src/datalink.ts

data

Type: DataView

▸ streamId

src/datalink.ts

streamId

Type: string

▸ pktid

src/datalink.ts

pktid

Type: string

▸ hppackettime

src/datalink.ts

hppackettime

Type: string

▸ hppacketstart

src/datalink.ts

hppacketstart

Type: string

▸ hppacketend

src/datalink.ts

hppacketend

Type: string

▸ dataSize

src/datalink.ts

dataSize

Type: number

▸ _miniseed

src/datalink.ts

_miniseed

Type: (null | miniseed.DataRecord)

▸ _mseed3

src/datalink.ts

_mseed3

Type: (null | mseed3.MSeed3Record)

▸ packetStart

src/datalink.ts

Packet start time as a DateTime.

packetStart

Type: DateTime

Returns

DateTime: start time

▸ packetEnd

src/datalink.ts

Packet end time as a DateTime.

packetEnd

Type: DateTime

Returns

DateTime: end time

▸ packetTime

src/datalink.ts

Packet time as a DateTime.

packetTime

Type: DateTime

Returns

DateTime: packet time

▸ isMiniseed()

src/datalink.ts

is this packet a miniseed packet

isMiniseed(): boolean

Returns

boolean: true if it is miniseed

▸ asMiniseed()

src/datalink.ts

Parsed payload as a miniseed data record, if the streamid ends with '/MSEED', null otherwise.

asMiniseed(): (miniseed.DataRecord | null)

Returns

(miniseed.DataRecord | null): miniseed DataRecord or null

▸ isMiniseed3()

src/datalink.ts

is this packet a miniseed3 packet

isMiniseed3(): boolean

Returns

boolean: true if it is miniseed3

▸ asMiniseed3()

src/datalink.ts

Parsed payload as a miniseed3 data record, if the data format is 3, null otherwise.

asMiniseed3(): (mseed3.MSeed3Record | null)

Returns

(mseed3.MSeed3Record | null): miniseed3 DataRecord or null

dateTimeToHPTime

src/datalink.ts

Convert DateTime to a HPTime number.

dateTimeToHPTime(m: DateTime): number

Parameters

m (DateTime) DateTime to convert

Returns

number: microseconds since epoch

hpTimeToMoment

src/datalink.ts

Convert hptime number to a DateTime.

hpTimeToMoment(hptime: number): DateTime

Parameters

hptime (number) hptime to convert

Returns

DateTime: DateTime in utc for the hptime

stringToUint8Array

src/datalink.ts

Encode string into a Uint8Array.

stringToUint8Array(dataString: string?): Uint8Array

Parameters

dataString (string?) String to encode.

Returns

Uint8Array: String as bytes in Uint8Array.