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 54 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 list< TMountPoint > | TListMountPoints |
Used in CNTRIPClient::retrieveListOfMountpoints. | |
Public Member Functions | |
CNTRIPClient () | |
Default constructor. | |
virtual | ~CNTRIPClient () |
Default destructor. | |
bool | open (const NTRIPArgs ¶ms, string &out_errmsg) |
Tries to open a given NTRIP stream and, if successful, launches a thread for continuously reading from it. | |
void | close () |
Closes the connection. | |
Static Public Member Functions | |
static bool | retrieveListOfMountpoints (TListMountPoints &out_list, string &out_errmsg, const string &server, int port=2101, const string &auth_user=string(), const string &auth_pass=string()) |
Connect to a given NTRIP caster and get the list of all available mountpoints and their parameters. | |
Public Attributes | |
mrpt::synch::MT_buffer | stream_data |
The buffer with all the bytes so-far read from the NTRIP server stream. | |
Protected Types | |
enum | TConnResult { connOk = 0, connError, connUnauthorized } |
Protected Member Functions | |
void | private_ntrip_thread () |
The working thread. | |
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". | |
bool | m_waiting_answer_connection |
TConnResult | m_answer_connection |
NTRIPArgs | m_args |
All the parameters for the NTRIP connection. |
typedef list<TMountPoint> mrpt::hwdrivers::CNTRIPClient::TListMountPoints |
Used in CNTRIPClient::retrieveListOfMountpoints.
Definition at line 93 of file CNTRIPClient.h.
enum mrpt::hwdrivers::CNTRIPClient::TConnResult [protected] |
Definition at line 127 of file CNTRIPClient.h.
mrpt::hwdrivers::CNTRIPClient::CNTRIPClient | ( | ) |
Default constructor.
virtual mrpt::hwdrivers::CNTRIPClient::~CNTRIPClient | ( | ) | [virtual] |
Default destructor.
void mrpt::hwdrivers::CNTRIPClient::close | ( | ) |
Closes the connection.
bool mrpt::hwdrivers::CNTRIPClient::open | ( | const NTRIPArgs & | params, |
string & | out_errmsg | ||
) |
Tries to open a given NTRIP stream and, if successful, launches a thread for continuously reading from it.
void mrpt::hwdrivers::CNTRIPClient::private_ntrip_thread | ( | ) | [protected] |
The working thread.
static bool mrpt::hwdrivers::CNTRIPClient::retrieveListOfMountpoints | ( | TListMountPoints & | out_list, |
string & | out_errmsg, | ||
const string & | server, | ||
int | port = 2101 , |
||
const string & | auth_user = string() , |
||
const string & | auth_pass = string() |
||
) | [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:
CNTRIPClient::TListMountPoints lst; std::string errMsg; bool ret = CNTRIPClient::retrieveListOfMountpoints(lst,errMsg,"www.euref-ip.net", 2101);
TConnResult mrpt::hwdrivers::CNTRIPClient::m_answer_connection [mutable, protected] |
Definition at line 133 of file CNTRIPClient.h.
NTRIPArgs mrpt::hwdrivers::CNTRIPClient::m_args [mutable, protected] |
All the parameters for the NTRIP connection.
Definition at line 134 of file CNTRIPClient.h.
Definition at line 121 of file CNTRIPClient.h.
Definition at line 120 of file CNTRIPClient.h.
Definition at line 119 of file CNTRIPClient.h.
bool mrpt::hwdrivers::CNTRIPClient::m_thread_do_process [mutable, protected] |
Will be "true" between "open" and "close".
Definition at line 124 of file CNTRIPClient.h.
bool mrpt::hwdrivers::CNTRIPClient::m_thread_exit [mutable, protected] |
Definition at line 123 of file CNTRIPClient.h.
bool mrpt::hwdrivers::CNTRIPClient::m_waiting_answer_connection [mutable, protected] |
Definition at line 125 of file CNTRIPClient.h.
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 156 of file CNTRIPClient.h.
Page generated by Doxygen 1.7.3 for MRPT 0.9.4 SVN: at Sat Mar 26 06:40:17 UTC 2011 |