Started documentation overhaul in doc/www
[barry/pauldeden.git] / src / m_ipmodem.h
blob6b5b5d895997e88076db4493cc85fa911fd5475f
1 ///
2 /// \file m_ipmodem.h
3 /// Mode class for GPRS modem mode (using endpoints on
4 /// modern devices)
5 ///
7 /*
8 Copyright (C) 2005-2007, Net Direct Inc. (http://www.netdirect.ca/)
10 This program is free software; you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation; either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
19 See the GNU General Public License in the COPYING file at the
20 root directory of this project for more details.
23 #ifndef __BARRY_M_IPMODEM_H__
24 #define __BARRY_M_IPMODEM_H__
26 #include "dll.h"
27 #include "usbwrap.h"
28 #include "data.h"
29 #include <pthread.h>
31 namespace Barry {
33 // forward declarations
34 class Controller;
36 namespace Mode {
38 class BXEXPORT IpModem
40 public:
41 typedef void (*DeviceDataCallback)(void *context, const unsigned char *data, int len);
43 private:
44 Controller &m_con;
45 Usb::Device &m_dev;
47 Data m_writeBuf; // used for 0x7e handling
49 // thread data
50 volatile bool m_continue_reading;
51 pthread_t m_modem_read_thread;
53 // write flags
54 bool m_ppp_mode;
55 unsigned char m_last;
57 // external callbacks
58 DeviceDataCallback m_callback;
59 void *m_callback_context;
61 protected:
62 static void *DataReadThread(void *userptr);
64 public:
65 IpModem(Controller &con, DeviceDataCallback callback, void *callback_context);
66 ~IpModem();
68 //////////////////////////////////
69 // general operations
70 void Open();
72 //////////////////////////////////
73 // UsbSerData mode - modem specific
75 // void Read(Data &data, int timeout); // can be called from separate thread
76 void Write(const Data &data, int timeout = -1);
79 }} // namespace Barry::Mode
81 #endif