IAX2FullFrameText Class Reference
#include <frame.h>
Inheritance diagram for IAX2FullFrameText:
Collaboration diagram for IAX2FullFrameText:
Public Member Functions | |
| IAX2FullFrameText (IAX2Processor *processor, const PString &textValue) | |
| IAX2FullFrameText (const IAX2Frame &srcFrame) | |
| IAX2FullFrameText (const IAX2FullFrame &srcFrame) | |
| virtual PString | GetSubClassName () const |
| virtual BYTE | GetFullFrameType () |
| PString | GetTextString () const |
 Public Member Functions inherited from IAX2FullFrame | |
| IAX2FullFrame (const IAX2Frame &srcFrame) | |
| IAX2FullFrame (IAX2EndPoint &_endpoint) | |
| virtual | ~IAX2FullFrame () |
| PBoolean | IsAckFrame () |
| PBoolean | IsPingFrame () |
| PBoolean | IsNewFrame () |
| PBoolean | IsLagRqFrame () |
| PBoolean | IsLagRpFrame () |
| PBoolean | IsPongFrame () |
| PBoolean | IsAuthReqFrame () |
| PBoolean | IsVnakFrame () |
| PBoolean | IsRegReqFrame () |
| PBoolean | IsRegAuthFrame () |
| PBoolean | IsRegAckFrame () |
| PBoolean | IsRegRelFrame () |
| PBoolean | IsRegRejFrame () |
| PBoolean | IsCallTokenFrame () |
| PBoolean | FrameIncrementsInSeqNo () |
| virtual PBoolean | IsFullFrame () |
| PBoolean | IsHangupFrame () |
| void | ZeroAllValues () |
| virtual PBoolean | ProcessNetworkPacket () |
| virtual PBoolean | TransmitPacket (PUDPSocket &sock) |
| PString | GetFullFrameName () const |
| void | MarkDeleteNow () |
| void | MarkVnakSendNow () |
| virtual BYTE * | GetMediaDataPointer () |
| virtual PINDEX | GetMediaDataSize () |
| PINDEX | GetSubClass () const |
| void | SetSubClass (PINDEX newValue) |
| virtual PBoolean | WriteHeader () |
| void | ModifyFrameHeaderSequenceNumbers (PINDEX inNo, PINDEX outNo) |
| void | ModifyFrameTimeStamp (PINDEX newTimeStamp) |
| virtual PBoolean | InformationElementsPresent () |
| PBoolean | SendFrameNow () |
| PBoolean | DeleteFrameNow () |
| IAX2SequenceNumbers & | GetSequenceInfo () |
| virtual void | PrintOn (ostream &strm) const |
| void | MarkAsResent () |
| PBoolean | operator*= (IAX2FullFrame &other) |
| virtual PINDEX | GetEncryptionOffset () |
| Public Member Functions inherited from IAX2Frame | |
| IAX2Frame (IAX2EndPoint &_endpoint) | |
| virtual | ~IAX2Frame () |
| PBoolean | ReadNetworkPacket (PUDPSocket &sock) |
| PBoolean | IsVideo () const |
| PBoolean | IsAudio () const |
| PINDEX | DataSize () |
| IAX2Remote & | GetRemoteInfo () |
| const BYTE * | GetDataPointer () |
| IAX2Frame * | BuildAppropriateFrameType (IAX2Encryption &encryptionInfo) |
| IAX2Frame * | BuildAppropriateFrameType () |
| PINDEX | GetUnReadBytes () |
| virtual void | BuildTimeStamp (const PTimeInterval &callStartTick) |
| IAX2EndPoint & | GetEndpoint () |
| PString | IdString () const |
| DWORD | GetTimeStamp () |
| void | SetTimeStamp (DWORD newValue) |
| IAX2FrameType | GetFrameType () |
| PBoolean | CanRetransmitFrame () const |
| PString | GetConnectionToken () const |
| void | SetConnectionToken (PString newToken) |
| void | BuildConnectionToken () |
| PBoolean | EncryptContents (IAX2Encryption &encData) |
Protected Attributes | |
| PString | internalText |
| Protected Attributes inherited from IAX2FullFrame | |
| PTimer | transmissionTimer |
| int | subClass |
| PTimeInterval | retryDelta |
| PTimeInterval | timeOffset |
| PINDEX | retries |
| IAX2SequenceNumbers | sequence |
| PBoolean | sendFrameNow |
| PBoolean | deleteFrameNow |
| PBoolean | packetResent |
| PBoolean | callMustBeActive |
| PBoolean | isAckFrame |
| Protected Attributes inherited from IAX2Frame | |
| IAX2Remote | remote |
| IAX2FrameType | frameType |
| IAX2EndPoint & | endpoint |
| PBYTEArray | data |
| PBoolean | isFullFrame |
| PBoolean | isVideo |
| PBoolean | isAudio |
| PINDEX | currentReadIndex |
| PINDEX | currentWriteIndex |
| DWORD | timeStamp |
| PBoolean | canRetransmitFrame |
| PString | connectionToken |
| DWORD | presetTimeStamp |
Additional Inherited Members | |
| Public Types inherited from IAX2FullFrame | |
| enum | ConnectionRequired { callActive, callIrrelevant } |
| Static Public Member Functions inherited from IAX2Frame | |
| static DWORD | CalcTimeStamp (const PTimeInterval &callStartTick) |
| Protected Types inherited from IAX2FullFrame | |
| enum | RetryTime { minRetryTime = 1000, maxRetryTime = 010000, maxRetries = 3 } |
| Protected Member Functions inherited from IAX2FullFrame | |
| virtual PBoolean | CallMustBeActive () |
| void | UnCompressSubClass (BYTE a) |
| int | CompressSubClass () |
| void | ClearListFlags () |
| virtual void | InitialiseHeader (IAX2Processor *processor) |
| void | OnTransmissionTimeout (PTimer &, INT) |
Detailed Description
Class for transfering text. These frames are sent reliably. There is no data in the subclass section.
The text is carried in the data section.
Constructor & Destructor Documentation
| IAX2FullFrameText::IAX2FullFrameText | ( | IAX2Processor * | processor, |
| const PString & | textValue | ||
| ) |
Construction from a Connection class. Classes generated from this are then on sent to a remote endpoint.
- Parameters
-
processor Iax Processor from which this frame originates textValue text to send to remote end
| IAX2FullFrameText::IAX2FullFrameText | ( | const IAX2Frame & | srcFrame | ) |
Construction from a supplied dataframe. In this case, this class is filled from an incoming data packet
| IAX2FullFrameText::IAX2FullFrameText | ( | const IAX2FullFrame & | srcFrame | ) |
Construction from a supplied dataframe. In this case, this class is filled from an incoming data packet
Member Function Documentation
|
inlinevirtual |
Return the IAX2FullFrame type represented here (voice, protocol, session etc
Reimplemented from IAX2FullFrame.
References IAX2Frame::textType.
|
virtual |
Get text description of the subclass contents
Reimplemented from IAX2FullFrame.
| PString IAX2FullFrameText::GetTextString | ( | ) | const |
Return the text data
Field Documentation
|
protected |
The text string that will be placed in the body of this message
The documentation for this class was generated from the following file:
