Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: XBeeZB_Receive_Data
Fork of
XBeeLib
by 
Digi International Inc.
FrameHandler Class Reference
Class for the frame handlers. More...
#include <FrameHandler.h>
Inherited by FH_ModemStatus, FH_AtCmdResp, FH_IoDataSampe16b802, FH_IoDataSampe64b802, FH_IoDataSampeDM, FH_IoDataSampeZB, FH_RxPacket16b802, FH_RxPacket64b802, FH_RxPacketDM, and FH_RxPacketZB.
Public Member Functions | |
| FrameHandler (ApiFrame::ApiFrameType type) | |
| Class constructor. | |
| virtual | ~FrameHandler () |
| Class destructor. | |
| ApiFrame::ApiFrameType | get_type () const |
| get_type returns the type of frames handled by this handler | |
| virtual void | process_frame_data (const ApiFrame *const frame)=0 |
| process_frame_data method called by the library to process the the incoming frames if the type matches. | |
Protected Attributes | |
| ApiFrame::ApiFrameType | _type |
| frame type handled by this handler | |
Friends | |
| class | ApiFrame |
Detailed Description
Class for the frame handlers.
Definition at line 19 of file FrameHandler.h.
Constructor & Destructor Documentation
Class constructor.
Copyright (c) 2015 Digi International Inc., All rights not expressly granted are reserved.
- Parameters:
-
type frame type handled by this frame handler
This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
Digi International Inc. 11001 Bren Road East, Minnetonka, MN 55343 =======================================================================
Definition at line 15 of file FrameHandler.cpp.
| ~FrameHandler | ( | ) | [virtual] |
Class destructor.
Definition at line 19 of file FrameHandler.cpp.
Member Function Documentation
| ApiFrame::ApiFrameType get_type | ( | ) | const |
get_type returns the type of frames handled by this handler
- Returns:
- the frame type handled by the handler
Definition at line 23 of file FrameHandler.cpp.
| virtual void process_frame_data | ( | const ApiFrame *const | frame ) | [pure virtual] |
process_frame_data method called by the library to process the the incoming frames if the type matches.
- Parameters:
-
frame pointer pointing to the api frame that must be processed
Field Documentation
ApiFrame::ApiFrameType _type [protected] |
frame type handled by this handler
Definition at line 49 of file FrameHandler.h.
Generated on Tue Jul 12 2022 19:44:23 by
1.7.2