HDLCFrame.h
上传用户:weiyuanprp
上传日期:2020-05-20
资源大小:1169k
文件大小:4k
- /* $Id: HDLCFrame.h,v 1.1.1.1 2005/11/11 21:32:02 faxguy Exp $ */
- /*
- * Copyright (c) 1990-1996 Sam Leffler
- * Copyright (c) 1991-1996 Silicon Graphics, Inc.
- * HylaFAX is a trademark of Silicon Graphics
- *
- * Permission to use, copy, modify, distribute, and sell this software and
- * its documentation for any purpose is hereby granted without fee, provided
- * that (i) the above copyright notices and this permission notice appear in
- * all copies of the software and related documentation, and (ii) the names of
- * Sam Leffler and Silicon Graphics may not be used in any advertising or
- * publicity relating to the software without the specific, prior written
- * permission of Sam Leffler and Silicon Graphics.
- *
- * THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND,
- * EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
- * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
- *
- * IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR
- * ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND,
- * OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
- * WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
- * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
- * OF THIS SOFTWARE.
- */
- #ifndef _HDLCFRAME_
- #define _HDLCFRAME_
- /*
- * Raw HDLC Frame Interface.
- */
- #include "Types.h"
- #include "FaxParams.h"
- class HDLCFrame {
- public:
- HDLCFrame(u_int frameOverhead);
- HDLCFrame(const HDLCFrame& fr);
- ~HDLCFrame();
- void put(u_char c); // Put the character "c" into the buffer
- void put(const u_char* c, u_int len);// Put bunch of bytes in the buffer
- void reset(); // Reset buffer to empty
- u_int getLength() const; // Return number of bytes in buffer
- operator u_char*(); // Return base of buffer
- u_char& operator[](u_int i) const; // NB: no bounds checking
- u_char& operator[](int i) const; // NB: no bounds checking
- bool moreFrames() const; // more frames follow
- bool isOK() const; // frame has good FCS
- bool checkCRC() const; // validate the CRC checksum
- u_int getCRC() const; // return the 1s complement of the CRC
- void setOK(bool b); // set frame FCS indicator
- u_int getRawFCF() const; // raw FCF in frame
- u_int getFCF() const; // FCF &~ (FCF_SNDR|FCF_RCVR)
- u_int getFCF2() const; // FCF2 for T.30 Annex A
- const u_char* getFrameData() const; // data following FCF
- u_int getFrameDataLength() const; // length of data - (FCF+FCS)
- u_int getDataWord() const; // first 0-4 bytes of data
- FaxParams getDIS() const; // DIS/DCS data
- protected:
- u_char buf[2048]; // large enough for TCF at 9600 baud
- u_char* next;
- u_char* end;
- u_char* base;
- u_short amountToGrowBy;
- u_short frameOverhead; // # bytes for leader & FCS
- u_int crc; // CRC16-CCITT calculation
- bool ok; // FCS correct
- void addc(u_char c); // make room & add a char to the buffer
- void grow(u_int amount); // make more room in the buffer
- void buildCRC(u_char c); // calculate the CRC for the frame
- };
- inline void HDLCFrame::put(u_char c)
- { if (next < end) *next++ = c; else addc(c); buildCRC(c); }
- inline void HDLCFrame::reset() { next = base; ok = false; crc = 0xffff; }
- inline u_int HDLCFrame::getLength() const { return next - base; }
- inline HDLCFrame::operator u_char*() { return base; }
- inline u_char& HDLCFrame::operator[](u_int i) const { return base[i]; }
- inline u_char& HDLCFrame::operator[](int i) const { return base[i]; }
- inline bool HDLCFrame::moreFrames() const
- { return ((*this)[1]&0x08) == 0; }
- inline bool HDLCFrame::isOK() const { return ok; }
- inline bool HDLCFrame::checkCRC() const { return crc == 0x1d0f; }
- inline u_int HDLCFrame::getCRC() const { return ~crc; }
- inline void HDLCFrame::setOK(bool b) { ok = b; }
- inline u_int HDLCFrame::getRawFCF() const { return (*this)[2]; }
- inline u_int HDLCFrame::getFCF() const { return (*this)[2]&0x7f; }
- inline u_int HDLCFrame::getFCF2() const { return (*this)[3]&0x7f; }
- inline const u_char* HDLCFrame::getFrameData() const { return &((*this)[3]); }
- inline u_int HDLCFrame::getFrameDataLength() const
- { u_int len = getLength(); return len > frameOverhead ? len - frameOverhead : 0; }
- #endif /* _HDLCFRAME_ */