obspy.clients.seedlink.client.seedlinkconnection.SeedLinkConnection¶
-
class
SeedLinkConnection
(timeout=None)[source]¶ Bases:
object
Class to manage a connection to a SeedLink server using a Socket.
See obspy.realtime.seedlink.SLClient for an example of how to create and use this SeedLinkConnection object. A new SeedLink application can be created by sub-classing SLClient, or by creating a new class and invoking the methods of SeedLinkConnection.
Variables: - SEEDLINK_PROTOCOL_PREFIX – URI/URL prefix for seedlink servers (“seedlink://”).
- UNISTATION – The station code used for uni-station mode.
- UNINETWORK – The network code used for uni-station mode.
- DFT_READBUF_SIZE – Default size for buffer to hold responses from server (default is 1024).
- QUOTE_CHAR – Character used for delimiting timestamp strings in the statefile.
Publicly accessible (get/set) parameters:
Variables: - sladdr – The host:port of the SeedLink server.
- keepalive – Interval to send keepalive/heartbeat (seconds) (default is 0 sec).
- netto – Network timeout (seconds) (default is 120 sec).
- netdly – Network reconnect delay (seconds) (default is 30 sec).
- info_string – String containing concatenation of contents of last terminated set of INFO packets.
- statefile – File name for storing state information.
- lastpkttime – Flag to control last packet time usage, if true, begin_time is appended to DATA command (Default is False).
Parameters: timeout (float) – Time in seconds after which a collect() call will be interrupted.
Protected parameters
Variables: - streams – Vector of SLNetStation objects.
- begin_time – Beginning of time window.
- end_time – End of time window.
- resume – Flag to control resuming with sequence numbers.
- multistation – Flag to indicate multistation mode.
- dialup – Flag to indicate dial-up mode.
- terminate_flag – Flag to control connection termination.
- server_id – ID of the remote SeedLink server.
- server_version – Version of the remote SeedLink server.
- info_request_string – INFO level to request.
- socket – The network socket.
- state – Persistent state information.
- infoStrBuf – String to store INFO packet contents.
Attributes
DFT_READBUF_SIZE
QUOTE_CHAR
SEEDLINK_PROTOCOL_PREFIX
UNINETWORK
UNISTATION
__dict__
__doc__
__module__
__weakref__
list of weak references to the object (if defined) Public Methods
add_stream
Add a new stream entry to the stream chain for the given net/station parameters. check_slcd
Check this SeedLinkConnection description has valid parameters. check_version
Checks server version number against a given specified value. close
Closes this SeedLinkConnection by closing the network socket and saving the state to the statefile, if it exists. collect
Manage a connection to a SeedLink server based on the values given in this SeedLinkConnection, and to collect data. config_link
Configure/negotiate data stream(s) with the remote SeedLink server. connect
Open a network socket connection to a SeedLink server. disconnect
Close the network socket associated with this connection. do_terminate
Terminate the collection loop. get_info_string
Returns the results of the last INFO request. get_keep_alive
Returns the interval to send keepalive/heartbeat (seconds). get_net_delay
Returns the network reconnect delay (seconds). get_net_timeout
Returns the network timeout (seconds). get_sl_address
Returns the host:port of the SeedLink server. get_state
Returns the SLState state object. get_streams
Returns a copy of the Vector of SLNetStation objects. is_connected
Returns connection state of the connection socket. is_connected_impl
Check a socket for write ability using select() negotiate_multi_station
Negotiate a SeedLink connection using multi-station mode and issue the END action command. negotiate_station
Negotiate a SeedLink connection for a single station and issue the DATA command. negotiate_uni_station
Negotiate a SeedLink connection in uni-station mode and issue the DATA command. parse_stream_list
Parse a string of streams and selectors and add them to the stream chain for configuring a multi-station connection. read_stream_list
Read a list of streams and selectors from a file and add them to the stream chain for configuring a multi-station connection. receive_data
Read bytes from the server. recover_state
Recover the state file and put the sequence numbers and time stamps into the pre-existing stream chain entries. request_info
Add an INFO request to the SeedLink Connection Description. save_state
Save all current sequence numbers and time stamps into the given state file. say_hello
Send the HELLO command and attempt to parse the server version number from the returned string. send_data
Send bytes to the server. send_info_request
Sends a request for the specified INFO level. set_begin_time
Sets begin_time for initiation of continuous data transmission. set_end_time
Sets end_time for termination of data transmission. set_keep_alive
Sets interval to send keepalive/heartbeat (seconds). set_last_pkt_time
Sets a specified start time for beginning of data transmission . set_net_delay
Sets the network reconnect delay (seconds). set_net_timeout
Sets the network timeout (seconds). set_sl_address
Sets the host:port of the SeedLink server. set_state_file
Set the state file and recover state. set_uni_params
Set the parameters for a uni-station mode connection for the given SLCD struct. terminate
Sets terminate flag, closes connection and clears state. update_stream
Update the appropriate stream chain entry given a Mini-SEED record. Special Methods
__dir__
Default dir() implementation. __format__
Default object formatter. __init__
Creates a new instance of SeedLinkConnection. __init_subclass__
This method is called when a class is subclassed. __new__
Create and return a new object. __reduce__
Helper for pickle. __reduce_ex__
Helper for pickle. __sizeof__
Size of object in memory, in bytes. __subclasshook__
Abstract classes can override this to customize issubclass().