OpenCPN Partial API docs
|
Public Member Functions | |
PeerData (EventVar &p) | |
Public Attributes | |
std::string | dest_ip_address |
std::string | server_name |
SemanticVersion | api_version |
server API version | |
std::vector< Route * > | routes |
std::vector< RoutePoint * > | routepoints |
std::vector< Track * > | tracks |
bool | overwrite |
API parameter, force overwrite w/o server dialogs. | |
bool | activate |
API parameter, activate route after transfer. | |
EventVar & | progress |
Notified with transfer percent progress (0-100). | |
std::function< PeerDlgResult(PeerDlg, int)> | run_status_dlg |
Dialog displaying status (good, bad, ...) | |
std::function< std::pair< PeerDlgResult, std::string >()> | run_pincode_dlg |
Pin confirm dialog, returns new {0, user_pin} or {error_code, error msg) | |
Definition at line 52 of file peer_client.h.
PeerData::PeerData | ( | EventVar & | p | ) |
Definition at line 60 of file peer_client.cpp.
bool PeerData::activate |
API parameter, activate route after transfer.
Definition at line 60 of file peer_client.h.
SemanticVersion PeerData::api_version |
server API version
Definition at line 55 of file peer_client.h.
std::string PeerData::dest_ip_address |
Definition at line 53 of file peer_client.h.
bool PeerData::overwrite |
API parameter, force overwrite w/o server dialogs.
Definition at line 59 of file peer_client.h.
EventVar& PeerData::progress |
Notified with transfer percent progress (0-100).
Definition at line 63 of file peer_client.h.
std::vector<RoutePoint*> PeerData::routepoints |
Definition at line 57 of file peer_client.h.
std::vector<Route*> PeerData::routes |
Definition at line 56 of file peer_client.h.
std::function<std::pair<PeerDlgResult, std::string>()> PeerData::run_pincode_dlg |
Pin confirm dialog, returns new {0, user_pin} or {error_code, error msg)
Definition at line 72 of file peer_client.h.
std::function<PeerDlgResult(PeerDlg, int)> PeerData::run_status_dlg |
Dialog displaying status (good, bad, ...)
Definition at line 66 of file peer_client.h.
std::string PeerData::server_name |
Definition at line 54 of file peer_client.h.
std::vector<Track*> PeerData::tracks |
Definition at line 58 of file peer_client.h.