2025/include/seiscomp/io/recordstream/slconnection.h

/***************************************************************************
 * Copyright (C) gempa GmbH                                                *
 * All rights reserved.                                                    *
 * Contact: gempa GmbH (seiscomp-dev@gempa.de)                             *
 *                                                                         *
 * GNU Affero General Public License Usage                                 *
 * This file may be used under the terms of the GNU Affero                 *
 * Public License version 3.0 as published by the Free Software Foundation *
 * and appearing in the file LICENSE included in the packaging of this     *
 * file. Please review the following information to ensure the GNU Affero  *
 * Public License version 3.0 requirements will be met:                    *
 * https://www.gnu.org/licenses/agpl-3.0.html.                             *
 *                                                                         *
 * Other Usage                                                             *
 * Alternatively, this file may be used in accordance with the terms and   *
 * conditions contained in a signed written agreement between you and      *
 * gempa GmbH.                                                             *
 ***************************************************************************/


#ifndef SEISCOMP_IO_RECORDSTREAM_SLINK_H
#define SEISCOMP_IO_RECORDSTREAM_SLINK_H


#include <string>
#include <set>
#include <iostream>
#include <sstream>
#include <signal.h>
#include <seiscomp/core/datetime.h>
#include <seiscomp/io/recordstream.h>
#include <seiscomp/core.h>
#include <seiscomp/io/socket.h>


namespace Seiscomp {
namespace RecordStream {


class SC_SYSTEM_CORE_API SeedlinkException: public Seiscomp::IO::RecordStreamException {
	public:
		SeedlinkException(): RecordStreamException("Seedlink exception") {}
		SeedlinkException(const std::string& what): RecordStreamException(what) {}
};

class SC_SYSTEM_CORE_API SeedlinkCommandException: public SeedlinkException {
	public:
		SeedlinkCommandException(): SeedlinkException("command not accepted") {}
		SeedlinkCommandException(const std::string& what): SeedlinkException(what) {}
};


class SC_SYSTEM_CORE_API SLStreamIdx {
	public:
		SLStreamIdx();

		SLStreamIdx(const std::string &net, const std::string &sta,
		            const std::string &loc, const std::string &cha);

		SLStreamIdx(const std::string &net, const std::string &sta,
		            const std::string &loc, const std::string &cha,
		            const OPT(Core::Time) &stime,
		            const OPT(Core::Time) &etime);

	public:
		SLStreamIdx& operator=(const SLStreamIdx &other);

		bool operator<(const SLStreamIdx &other) const;
		bool operator==(const SLStreamIdx &other) const;

	public:
		//! Returns the network code
		const std::string &network() const;

		//! Returns the station code
		const std::string &station() const;

		//! Returns the channel code
		const std::string &channel() const;

		//! Returns the location code
		const std::string &location() const;

		//! Returns the selector in <location><channel>.D notation
		//! * wildcards are substituted by a corresponding number of ?
		std::string selector() const;

		//! Returns the start time
		const OPT(Core::Time) &startTime() const;

		//! Returns the end time
		const OPT(Core::Time) &endTime() const;

		//! Returns the most recent record end time
		const OPT(Core::Time) &timestamp() const;

		//! Sets the time stamp
		void setTimestamp(const OPT(Core::Time) &rectime) const;

	private:
		const std::string       _net;
		const std::string       _sta;
		const std::string       _loc;
		const std::string       _cha;
		const OPT(Core::Time)   _stime;
		const OPT(Core::Time)   _etime;
		mutable OPT(Core::Time) _timestamp;
};


DEFINE_SMARTPOINTER(SLConnection);
class SC_SYSTEM_CORE_API SLConnection : public Seiscomp::IO::RecordStream {
	DECLARE_SC_CLASS(SLConnection);

	public:
		//! C'tor
		SLConnection();

		//! Initializing Constructor
		SLConnection(std::string serverloc);

		//! Destructor
		~SLConnection() override;

	public:
		//! The recordtype cannot be selected when using a seedlink
		//! connection. It will always create MiniSeed records
		bool setRecordType(const char*) override;

		//! Initialize the seedlink connection.
		bool setSource(const std::string &source) override;

		//! Adds the given stream to the server connection description
		bool addStream(const std::string &networkCode,
		               const std::string &stationCode,
		               const std::string &locationCode,
		               const std::string &channelCode) override;

		//! Adds a seismic stream request to the record stream (not implemented)
		bool addStream(const std::string &networkCode,
		               const std::string &stationCode,
		               const std::string &locationCode,
		               const std::string &channelCode,
		               const OPT(Core::Time) &startTime,
		               const OPT(Core::Time) &endTime) override;

		//! Adds the given start time to the server connection description
		bool setStartTime(const OPT(Core::Time) &startTime) override;

		//! Adds the given end time to the server connection description
		bool setEndTime(const OPT(Core::Time) &endTime) override;

		//! Sets timeout
		bool setTimeout(int seconds) override;

		//! Disconnects and terminates (!) the seedlink connection.
		void close() override;


	private:
		//! Reads the data stream
		virtual Record *next() override;

		//! Removes all stream list, time window, etc. -entries from the connection description object.
		bool clear();

		//! Reconnects a terminated seedlink connection.
		bool reconnect();

		void handshake();


	private:
		class StreamBuffer : public std::streambuf {
			public:
				StreamBuffer();
				std::streambuf *setbuf(char *s, std::streamsize n) override;
		};

		StreamBuffer          _streambuf;
		std::string           _serverloc;
		std::string           _slrecord;
		IO::Socket            _sock;
		std::set<SLStreamIdx> _streams;
		OPT(Core::Time)       _stime;
		OPT(Core::Time)       _etime;
		bool                  _readingData;
		bool                  _useBatch;
		int                   _maxRetries;
		int                   _retriesLeft;
};


}
}


#endif