GNU Radio's SATNOGS Package
tcp_rigctl_msg_source.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * gr-satnogs: SatNOGS GNU Radio Out-Of-Tree Module
4  *
5  * Copyright (C) 2016, Libre Space Foundation <http://librespacefoundation.org/>
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  */
20 
21 #ifndef INCLUDED_SATNOGS_TCP_RIGCTL_MSG_SOURCE_H
22 #define INCLUDED_SATNOGS_TCP_RIGCTL_MSG_SOURCE_H
23 
24 #include <satnogs/api.h>
25 #include <gnuradio/block.h>
26 
27 namespace gr {
28 namespace satnogs {
29 
30 /*!
31  * \brief Block that accepts TCP messages with rigctl commands. Depending
32  * the command contents this block produces an appropriate PMT message
33  * to control other blocks in the flowgraph
34  * \ingroup satnogs
35  *
36  */
37 class SATNOGS_API tcp_rigctl_msg_source : virtual public gr::block {
38 public:
39  typedef boost::shared_ptr<tcp_rigctl_msg_source> sptr;
40 
41 
42  /**
43  * Rigctl TCP command accepter
44  *
45  * @param addr the address of the interface to listen at
46  * @param port the TCP port to listen or connect
47  * @param server_mode If set to yes this block, act as a rigctl server.
48  * Otherwise as a rigctl client
49  * @param interval_ms The interval in milliseconds at which the client
50  * request the frequency from the rigctl
51  * @param mtu the maximum MTU
52  * @return shared pointer of the block
53  */
54  static sptr
55  make(const std::string &addr, uint16_t port, bool server_mode,
56  size_t interval_ms = 1000, size_t mtu = 1500);
57 };
58 
59 } // namespace satnogs
60 } // namespace gr
61 
62 #endif /* INCLUDED_SATNOGS_TCP_RIGCTL_MSG_SOURCE_H */
63 
Block that accepts TCP messages with rigctl commands. Depending the command contents this block produ...
Definition: tcp_rigctl_msg_source.h:37
boost::shared_ptr< tcp_rigctl_msg_source > sptr
Definition: tcp_rigctl_msg_source.h:39
Definition: amsat_duv_decoder.h:29
#define SATNOGS_API
Definition: api.h:30