Program Listing for File UDPReceiveDB.h

↰ Return to documentation for file (/home/docs/checkouts/readthedocs.org/user_builds/ska-telescope-ska-pst-recv/checkouts/latest/src/ska/pst/recv/clients/UDPReceiveDB.h)

/*
 * Copyright 2022 Square Kilometre Array Observatory
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#include <iostream>
#include <cstdlib>
#include <pthread.h>
#include <string>

#include "ska/pst/smrb/DataBlockWrite.h"
#include "ska/pst/recv/formats/UDPFormat.h"
#include "ska/pst/recv/network/UDPStats.h"
#include "ska/pst/recv/clients/Receiver.h"

#ifndef __SKA_PST_RECV_CLIENTS_UDPReceiveDB_h
#define __SKA_PST_RECV_CLIENTS_UDPReceiveDB_h

namespace ska::pst::recv {

  class UDPReceiveDB : public Receiver {

    public:

      UDPReceiveDB(std::shared_ptr<SocketReceive> sock, const std::string& host);

      UDPReceiveDB(std::shared_ptr<SocketReceive> sock, const std::string& host, int port);

      virtual ~UDPReceiveDB();

      void perform_configure_beam();

      void perform_deconfigure_beam();

      void perform_configure_scan();

      void perform_deconfigure_scan();

      void perform_scan();

      void perform_start_scan();

      void perform_terminate();

      uint64_t get_data_bufsz() override;

    protected:

      std::unique_ptr<ska::pst::smrb::DataBlockWrite> db{nullptr};

      std::unique_ptr<ska::pst::smrb::DataBlockWrite> wb{nullptr};

      std::shared_ptr<UDPFormat> format{nullptr};

      std::shared_ptr<SocketReceive> socket{nullptr};

    private:

      void receive_block();

      void close_curr_bufs();

      std::vector<std::string> keys_to_remove{"DB_BUFSZ", "DB_NBUFS", "WB_BUFSZ", "WB_NBUFS", "HB_BUFSZ", "HB_NBUFS"};

  };

} // ska::pst::recv

#endif // __SKA_PST_RECV_CLIENTS_UDPReceiveDB_h