A client for NTRIP (HTTP) sources of differential GPS corrections from internet servers, or Global navigation satellite system (GNSS) internet radio.
Usage:
It is not neccesary to call "close", the connection is ended at destruction.
Definition at line 36 of file CNTRIPClient.h.
#include <mrpt/hwdrivers/CNTRIPClient.h>
Classes | |
struct | NTRIPArgs |
The arguments for connecting to a NTRIP stream, used in CNTRIPClient::open. More... | |
struct | TMountPoint |
A descriptor of one stream in an NTRIP Caster - See CNTRIPClient::retrieveListOfMountpoints. More... | |
Public Types | |
typedef std::list< TMountPoint > | TListMountPoints |
Used in CNTRIPClient::retrieveListOfMountpoints. More... | |
Public Member Functions | |
CNTRIPClient () | |
Default constructor. More... | |
virtual | ~CNTRIPClient () |
Default destructor. More... | |
bool | open (const NTRIPArgs ¶ms, std::string &out_errmsg) |
Tries to open a given NTRIP stream and, if successful, launches a thread for continuously reading from it. More... | |
void | close () |
Closes the connection. More... | |
void | sendBackToServer (const std::string &data) |
Enqueues a string to be sent back to the NTRIP server (e.g. More... | |
Static Public Member Functions | |
static bool | retrieveListOfMountpoints (TListMountPoints &out_list, std::string &out_errmsg, const std::string &server, int port=2101, const std::string &auth_user=std::string(), const std::string &auth_pass=std::string()) |
Connect to a given NTRIP caster and get the list of all available mountpoints and their parameters. More... | |
Public Attributes | |
mrpt::synch::MT_buffer | stream_data |
The buffer with all the bytes so-far read from the NTRIP server stream. More... | |
Protected Types | |
enum | TConnResult { connOk = 0, connError, connUnauthorized } |
Protected Member Functions | |
void | private_ntrip_thread () |
The working thread. More... | |
Protected Attributes | |
mrpt::system::TThreadHandle | m_thread |
mrpt::synch::CSemaphore | m_sem_sock_closed |
mrpt::synch::CSemaphore | m_sem_first_connect_done |
bool | m_thread_exit |
bool | m_thread_do_process |
Will be "true" between "open" and "close". More... | |
bool | m_waiting_answer_connection |
TConnResult | m_answer_connection |
NTRIPArgs | m_args |
All the parameters for the NTRIP connection. More... | |
mrpt::synch::MT_buffer | m_upload_data |
Buffer for data to be sent back to the server. More... | |
typedef std::list<TMountPoint> mrpt::hwdrivers::CNTRIPClient::TListMountPoints |
Used in CNTRIPClient::retrieveListOfMountpoints.
Definition at line 75 of file CNTRIPClient.h.
|
protected |
Enumerator | |
---|---|
connOk | |
connError | |
connUnauthorized |
Definition at line 109 of file CNTRIPClient.h.
mrpt::hwdrivers::CNTRIPClient::CNTRIPClient | ( | ) |
Default constructor.
|
virtual |
Default destructor.
void mrpt::hwdrivers::CNTRIPClient::close | ( | ) |
Closes the connection.
bool mrpt::hwdrivers::CNTRIPClient::open | ( | const NTRIPArgs & | params, |
std::string & | out_errmsg | ||
) |
Tries to open a given NTRIP stream and, if successful, launches a thread for continuously reading from it.
|
protected |
The working thread.
|
static |
Connect to a given NTRIP caster and get the list of all available mountpoints and their parameters.
Note that the authentication parameters "auth_user" and "auth_pass" will be left empty in most situations, since LISTING the Caster normally doesn't require special rights.
Example:
void mrpt::hwdrivers::CNTRIPClient::sendBackToServer | ( | const std::string & | data | ) |
Enqueues a string to be sent back to the NTRIP server (e.g.
GGA frames)
|
mutableprotected |
Definition at line 115 of file CNTRIPClient.h.
|
mutableprotected |
All the parameters for the NTRIP connection.
Definition at line 116 of file CNTRIPClient.h.
|
protected |
Definition at line 103 of file CNTRIPClient.h.
|
protected |
Definition at line 102 of file CNTRIPClient.h.
|
protected |
Definition at line 101 of file CNTRIPClient.h.
|
mutableprotected |
Will be "true" between "open" and "close".
Definition at line 106 of file CNTRIPClient.h.
|
mutableprotected |
Definition at line 105 of file CNTRIPClient.h.
|
protected |
Buffer for data to be sent back to the server.
Definition at line 118 of file CNTRIPClient.h.
|
mutableprotected |
Definition at line 107 of file CNTRIPClient.h.
mrpt::synch::MT_buffer mrpt::hwdrivers::CNTRIPClient::stream_data |
The buffer with all the bytes so-far read from the NTRIP server stream.
Call its "readAndClear" method in a timely fashion to get the stream contents.
Definition at line 140 of file CNTRIPClient.h.
Page generated by Doxygen 1.8.12 for MRPT 1.3.2 SVN: at Mon Oct 3 19:22:36 UTC 2016 |