diff options
Diffstat (limited to 'gr-digital/include/digital_packet_sink.h')
| -rw-r--r-- | gr-digital/include/digital_packet_sink.h | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/gr-digital/include/digital_packet_sink.h b/gr-digital/include/digital_packet_sink.h index f9f51f6b1..7ab41c0ef 100644 --- a/gr-digital/include/digital_packet_sink.h +++ b/gr-digital/include/digital_packet_sink.h @@ -38,6 +38,25 @@ digital_make_packet_sink(const std::vector<unsigned char>& sync_vector, /*! * \brief process received bits looking for packet sync, header, and process bits into packet * \ingroup sink_blk + * + * input: stream of symbols to be sliced. + * + * output: none. Pushes assembled packet into target queue + * + * The packet sink takes in a stream of binary symbols that are sliced + * around 0. The bits are then checked for the \p sync_vector to + * determine find and decode the packet. It then expects a fixed + * length header of 2 16-bit shorts containing the payload length, + * followed by the payload. If the 2 16-bit shorts are not identical, + * this packet is ignored. Better algs are welcome. + * + * This block is not very useful anymore as it only works with 2-level + * modulations such as BPSK or GMSK. The block can generally be + * replaced with a correlate access code and frame sink blocks. + * + * \param sync_vector The synchronization vector as a vector of 1's and 0's. + * \param target_queue The message queue that packets are sent to. + * \param threshold Number of bits that can be incorrect in the \p sync_vector. */ class DIGITAL_API digital_packet_sink : public gr_sync_block { |