ppp: minor cleanups to match other chatscripts order and documentation
[barry.git] / src / m_ipmodem.h
blob084c43ba5370772029178c137f62f0de7d2eeb0e
1 ///
2 /// \file m_ipmodem.h
3 /// Mode class for GPRS modem mode (using endpoints on
4 /// modern devices)
5 ///
7 /*
8 Copyright (C) 2008-2010, 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 "modem.h"
28 #include "usbwrap.h"
29 #include "data.h"
30 #include "pppfilter.h"
31 #include <pthread.h>
33 #define SB_IPMODEM_SESSION_KEY_LENGTH 8
35 namespace Barry {
37 // forward declarations
38 class Controller;
40 namespace Mode {
42 class BXEXPORT IpModem : public Modem
44 public:
45 typedef void (*DeviceDataCallback)(void *context, const unsigned char *data, int len);
47 private:
48 Controller &m_con;
49 Usb::Device &m_dev;
51 PppFilter m_filter; // used for 0x7e handling
53 // thread data
54 volatile bool m_continue_reading;
55 pthread_t m_modem_read_thread;
57 // external callbacks
58 DeviceDataCallback m_callback;
59 void *m_callback_context;
61 unsigned char m_session_key[SB_IPMODEM_SESSION_KEY_LENGTH]; // = { 0x00, 0, 0, 0, 0, 0, 0, 0 };
63 private:
64 BXLOCAL bool SendPassword(const char *password, uint32_t seed);
66 protected:
67 static void *DataReadThread(void *userptr);
69 public:
70 IpModem(Controller &con, DeviceDataCallback callback, void *callback_context);
71 ~IpModem();
73 //////////////////////////////////
74 // general operations
75 void Open(const char *password = 0);
76 void Close();
78 //////////////////////////////////
79 // UsbSerData mode - modem specific
81 // void Read(Data &data, int timeout); // can be called from separate thread
82 void Write(const Data &data, int timeout = -1);
85 }} // namespace Barry::Mode
87 #endif