OPAL Version 3.10.4

- Main Page
- Related Pages
- Namespaces
- Data Structures
- Files

- Data Structures
- Class Hierarchy
- Data Fields

Public Member Functions
H224_Frame Class Reference

`#include <h224.h>`

Inheritance diagram for H224_Frame:

## Public Member Functions

| H224_Frame (PINDEX clientDataSize=254)
| H224_Frame (const OpalH224Client &h224Client, PINDEX clientDataSize=254)
| ~H224_Frame ()
PBoolean | IsHighPriority () const
void | SetHighPriority (PBoolean flag)
WORD | GetDestinationTerminalAddress () const
void | SetDestinationTerminalAddress (WORD destination)
WORD | GetSourceTerminalAddress () const
void | SetSourceTerminalAddress (WORD source)
void | SetClient (const OpalH224Client &h224Client)
BYTE | GetClientID () const
void | SetClientID (BYTE clientID)
BYTE | GetExtendedClientID () const
void | SetExtendedClientID (BYTE extendedClientID)
BYTE | GetCountryCode () const
BYTE | GetCountryCodeExtension () const
WORD | GetManufacturerCode () const
BYTE | GetManufacturerClientID () const
void | SetNonStandardClientInformation (BYTE countryCode, BYTE countryCodeExtension, WORD manufacturerCode, BYTE manufacturerClientID)
PBoolean | GetBS () const
void | SetBS (PBoolean bs)
PBoolean | GetES () const
void | SetES (PBoolean es)
PBoolean | GetC1 () const
void | SetC1 (PBoolean c1)
PBoolean | GetC0 () const
void | SetC0 (PBoolean c0)
BYTE | GetSegmentNumber () const
void | SetSegmentNumber (BYTE segmentNumber)
BYTE * | GetClientDataPtr () const
PINDEX | GetClientDataSize () const
void | SetClientDataSize (PINDEX size)
PBoolean | DecodeAnnexQ (const BYTE *data, PINDEX size)
PBoolean | DecodeHDLC (const BYTE *data, PINDEX size)
Public Member Functions inherited from Q922_Frame
| Q922_Frame (PINDEX informationFieldSize=260)
| ~Q922_Frame ()
BYTE | GetHighOrderAddressOctet () const
BYTE | GetLowOrderAddressOctet () const
void | SetHighOrderAddressOctet (BYTE octet)
void | SetLowOrderAddressOctet (BYTE octet)
BYTE | GetControlFieldOctet () const
void | SetControlFieldOctet (BYTE octet)
BYTE * | GetInformationFieldPtr () const
PINDEX | GetInformationFieldSize () const
void | SetInformationFieldSize (PINDEX size)
PINDEX | GetAnnexQEncodedSize () const
PBoolean | EncodeAnnexQ (BYTE *buffer, PINDEX &size) const
PINDEX | GetHDLCEncodedSize () const
PBoolean | EncodeHDLC (BYTE *buffer, PINDEX &size) const
PBoolean | EncodeHDLC (BYTE *buffer, PINDEX &size, BYTE &bitPosition) const

## Additional Inherited Members

Protected Attributes inherited from Q922_Frame
PINDEX | informationFieldSize

## Constructor & Destructor Documentation

H224_Frame::H224_Frame | ( | PINDEX | clientDataSize = `254` | ) |

H224_Frame::H224_Frame | ( | const OpalH224Client & | h224Client,
|  | PINDEX | clientDataSize = `254`
| ) |  |

H224_Frame::~H224_Frame | ( |  | ) |

## Member Function Documentation

PBoolean H224_Frame::DecodeAnnexQ | ( | const BYTE * | buffer,
|  | PINDEX | size
| ) |  |

Decodes a Q.922 frame from a given buffer, encoded as descibed in H.323 Annex Q. Returns the success of this operation

Reimplemented from Q922_Frame.

PBoolean H224_Frame::DecodeHDLC | ( | const BYTE * | data,
|  | PINDEX | size
| ) |  |

Decodes a Q.922 frame from a given buffer. Returns the success of this operation

Reimplemented from Q922_Frame.

PBoolean H224_Frame::GetBS | ( |  | ) | const

Note: The following methods depend on the value of clientID as to where put the value. Always set clientID first before altering these values

PBoolean H224_Frame::GetC0 | ( |  | ) | const

PBoolean H224_Frame::GetC1 | ( |  | ) | const

BYTE* H224_Frame::GetClientDataPtr | ( |  | ) | const

Referenced by H281_Frame::GetRequestType().

PINDEX H224_Frame::GetClientDataSize | ( |  | ) | const

BYTE H224_Frame::GetClientID | ( |  | ) | const

BYTE H224_Frame::GetCountryCode | ( |  | ) | const

Returns 0 in case clientID isn't set to NonStandardClientID

BYTE H224_Frame::GetCountryCodeExtension | ( |  | ) | const

WORD H224_Frame::GetDestinationTerminalAddress | ( |  | ) | const

PBoolean H224_Frame::GetES | ( |  | ) | const

BYTE H224_Frame::GetExtendedClientID | ( |  | ) | const

Returns 0 in case clientID isn't set to ExtendedClientID

BYTE H224_Frame::GetManufacturerClientID | ( |  | ) | const

WORD H224_Frame::GetManufacturerCode | ( |  | ) | const

BYTE H224_Frame::GetSegmentNumber | ( |  | ) | const

WORD H224_Frame::GetSourceTerminalAddress | ( |  | ) | const

PBoolean H224_Frame::IsHighPriority | ( |  | ) | const

inline

References Q922_Frame::GetLowOrderAddressOctet().

void H224_Frame::SetBS | ( | PBoolean | bs | ) |

void H224_Frame::SetC0 | ( | PBoolean | c0 | ) |

void H224_Frame::SetC1 | ( | PBoolean | c1 | ) |

void H224_Frame::SetClient | ( | const OpalH224Client & | h224Client | ) |

Convenience function to set the H.224 header values

void H224_Frame::SetClientDataSize | ( | PINDEX | size | ) |

void H224_Frame::SetClientID | ( | BYTE | clientID | ) |

void H224_Frame::SetDestinationTerminalAddress | ( | WORD | destination | ) |

void H224_Frame::SetES | ( | PBoolean | es | ) |

void H224_Frame::SetExtendedClientID | ( | BYTE | extendedClientID | ) |

Does nothing in case clientID isn't set to ExtendedClientID

void H224_Frame::SetHighPriority | ( | PBoolean | flag | ) |

void H224_Frame::SetNonStandardClientInformation | ( | BYTE | countryCode,
|  | BYTE | countryCodeExtension,
|  | WORD | manufacturerCode,
|  | BYTE | manufacturerClientID
| ) |  |

Does nothing in case clientID isn't set to NonStandardClientID

void H224_Frame::SetSegmentNumber | ( | BYTE | segmentNumber | ) |

void H224_Frame::SetSourceTerminalAddress | ( | WORD | source | ) |

The documentation for this class was generated from the following file:

- h224.h