FH_ModemStatus.h

00001 /**
00002  * Copyright (c) 2015 Digi International Inc.,
00003  * All rights not expressly granted are reserved.
00004  *
00005  * This Source Code Form is subject to the terms of the Mozilla Public
00006  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
00007  * You can obtain one at http://mozilla.org/MPL/2.0/.
00008  *
00009  * Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343
00010  * =======================================================================
00011  */
00012 
00013 #if !defined(__FH_MODEM_STATUS_H_)
00014 #define __FH_MODEM_STATUS_H_
00015 
00016 #include "Frames/AtCmdFrame.h"
00017 #include "FrameHandler.h"
00018 
00019 typedef void (*modem_status_cb_t)(AtCmdFrame::ModemStatus status);
00020 
00021 class FH_ModemStatus : public FrameHandler
00022 {
00023     private:
00024         /** Callback function, invoked (if registered) when a modem status packet is received */
00025         modem_status_cb_t modem_status_cb;
00026 
00027     public:
00028         /** Class constructor */
00029         FH_ModemStatus();
00030 
00031         /** Class destructor */
00032         virtual ~FH_ModemStatus();
00033 
00034          /** Method called by the stack to process the modem status frame data
00035 
00036              \param frame pointer pointing to api frame that must be processed */
00037         virtual void process_frame_data(const ApiFrame *const frame);
00038 
00039         virtual void register_modem_status_cb(modem_status_cb_t function);
00040 
00041         virtual void unregister_modem_status_cb(void);
00042 };
00043 
00044 #endif /* __FH_MODEM_STATUS_H_ */