seisplotjs 3.2.0 | Documentation

seisplotjs

3.2.0

SEEDLINK_PATH
DATALINK_PATH
RingserverIdType
StreamStatType
StreamsResultType
IRIS_HOST
RingserverConnection ▸
- Instance members
- #isFDSNSourceId
- #dlproto
- #host
- #getHost
- #port
- #getPort
- #protocol
- #getProtocol
- #prefix
- #getPrefix
- #timeout
- #getTimeout
- #pullId
- #pullStreamIds
- #pullStreams
- #getDataLinkURL
- #getSeedLinkURL
- #formBaseURL
- #formIdURL
- #formStreamsURL
- #formStreamIdsURL
stationsFromStreams
typeForId
sidForId

Need help reading this?

SEEDLINK_PATH

src/ringserverweb4.ts

SEEDLINK_PATH

Type: string

DATALINK_PATH

src/ringserverweb4.ts

DATALINK_PATH

Type: string

RingserverIdType

src/ringserverweb4.ts

RingserverIdType

Type: z.infer<any>

StreamStatType

src/ringserverweb4.ts

StreamStatType

Type: z.infer<any>

StreamsResultType

src/ringserverweb4.ts

StreamsResultType

Type: z.infer<any>

IRIS_HOST

src/ringserverweb4.ts

IRIS_HOST

Type: string

RingserverConnection

src/ringserverweb4.ts

Web connection to a Ringserver.

new RingserverConnection(host: string?, port: number?)

Parameters

host (string?) optional host to connect to, defaults to IRIS. This maybe a full URL.

port (number?) optional host to connect to, defaults to 80

Instance Members

▸ isFDSNSourceId

src/ringserverweb4.ts

isFDSNSourceId

▸ dlproto

src/ringserverweb4.ts

dlproto

▸ host(value?)

src/ringserverweb4.ts

Gets/Sets the remote host to connect to.

host(value: string?): RingserverConnection

Parameters

value (string?) optional new value if setting

Returns

RingserverConnection: new value if getting, this if setting

▸ getHost()

src/ringserverweb4.ts

getHost(): string

Returns

string

▸ port(value?)

src/ringserverweb4.ts

Gets/Sets the remote port to connect to.

port(value: number?): RingserverConnection

Parameters

value (number?) optional new value if setting

Returns

RingserverConnection: new value if getting, this if setting

▸ getPort()

src/ringserverweb4.ts

getPort(): (number | undefined)

Returns

(number | undefined)

▸ protocol(value?)

src/ringserverweb4.ts

Gets/Sets the protocol, http or https. This should match the protocol of the page loaded, but is autocalculated and generally need not be set.

protocol(value: string?): RingserverConnection

Parameters

value (string?) protocol, usually http or https

Returns

RingserverConnection: the query when setting, the current value when no argument

▸ getProtocol()

src/ringserverweb4.ts

getProtocol(): (string | undefined)

Returns

(string | undefined)

▸ prefix(value?)

src/ringserverweb4.ts

Sets the prefix for the URL path.

prefix(value: string?): RingserverConnection

Parameters

value (string?) optional new value if setting

Returns

RingserverConnection: new value if getting, this if setting

▸ getPrefix()

src/ringserverweb4.ts

getPrefix(): string

Returns

string

▸ timeout(value?)

src/ringserverweb4.ts

Get/Set the timeout in seconds for the request. Default is 30.

timeout(value: number?): RingserverConnection

Parameters

value (number?) optional new value if setting

Returns

RingserverConnection: new value if getting, this if setting

▸ getTimeout()

src/ringserverweb4.ts

getTimeout(): (number | undefined)

Returns

(number | undefined)

▸ pullId()

src/ringserverweb4.ts

Pulls id result from ringserver /id parsed into an object with 'ringserverVersion' and 'serverId' fields. Also sets the isFDSNSourceId value as ringserver v4 uses new FDSN style ids while

pullId(): Promise<RingserverIdType>

Returns

Promise<RingserverIdType>: Result as a Promise.

▸ pullStreamIds(matchPattern?, level)

src/ringserverweb4.ts

The optional matchPattern is a regular expression, so for example '.+_JSC_00_HH.' would get all HH? channels from any station name JSC.

pullStreamIds(matchPattern: string?, level: any): Promise<Array<string>>

Parameters

matchPattern (string?) regular expression to match

level (any) 1-6

Returns

Promise<Array<string>>: Result as a Promise.

▸ pullStreams(matchPattern?)

src/ringserverweb4.ts

Pull streams, including start and end times, from the ringserver. The optional matchPattern is a regular expression, so for example '.+_JSC_00_HH.' would get all HH? channels from any station name JSC. Result returned is an Promise.

pullStreams(matchPattern: string?): Promise<StreamsResultType>

Parameters

matchPattern (string?) regular expression to match

Returns

Promise<StreamsResultType>: promise to object with 'accessTime' as a DateTime and 'streams' as an array of StreamStat objects.

▸ getDataLinkURL()

src/ringserverweb4.ts

getDataLinkURL(): string

Returns

string

▸ getSeedLinkURL()

src/ringserverweb4.ts

getSeedLinkURL(): string

Returns

string

▸ formBaseURL()

src/ringserverweb4.ts

Forms base url from protocol, host and port.

formBaseURL(): string

Returns

string: the string url

▸ formIdURL()

src/ringserverweb4.ts

Forms the ringserver id/json url.

formIdURL(): string

Returns

string: the id url

▸ formStreamsURL(queryParams?)

src/ringserverweb4.ts

Forms the ringserver streams/json url using the query parameters.

formStreamsURL(queryParams: string?): string

Parameters

queryParams (string?) optional string of query parameters

Returns

string: the streams url

▸ formStreamIdsURL(queryParams)

src/ringserverweb4.ts

Forms the ringserver stream ids url using the query parameters.

formStreamIdsURL(queryParams: string): string

Parameters

queryParams (string) optional string of query parameters

Returns

string: the stream ids url

stationsFromStreams

src/ringserverweb4.ts

Extract one StreamStat per station from an array of channel level StreamStats. The start and end times are the min and max times for all the channels within the station. Can be used to get most time of most recent packet from the stations to give an idea of current latency.

stationsFromStreams(streams: Array<StreamStatType>): Array<StreamStatType>

Parameters

streams (Array<StreamStatType>) array of channel level StreamStats

Returns

Array<StreamStatType>: array of station level StreamStats

typeForId

src/ringserverweb4.ts

extracts the type from a ringserver id, ie the type from xxx/type.

typeForId(id: string): (string | null)

Parameters

id (string) ringserver/datalink style id

Returns

(string | null): type, usually MSEED, MSEED3, JSON or TEXT

sidForId

src/ringserverweb4.ts

extracts the source id from a ringserver id, ie the source id from NN_SSSSS_LL_CCC/type or FDSN:NN_SSSSS_LL_B_S_S/type

sidForId(id: string): (FDSNSourceId | StationSourceId | NetworkSourceId | null)

Parameters

id (string) ringserver/datalink style id

Returns

(FDSNSourceId | StationSourceId | NetworkSourceId | null): FDSN source id or null