Documentation

Encoder
in package

Encodes Message objects to raw network data

Tags
category

LibDNS

author

Chris Wright https://github.com/DaveRandom

Table of Contents

Properties

$encodingContextFactory  : EncodingContextFactory
$packetFactory  : PacketFactory

Methods

__construct()  : mixed
Constructor
encode()  : string
Encode a Message to raw network data
encodeAnything()  : string
Encode an Anything field
encodeBitMap()  : string
Encode a BitMap field
encodeChar()  : string
Encode a Char field
encodeCharacterString()  : string
Encode a CharacterString field
encodeDomainName()  : string
Encode a DomainName field
encodeHeader()  : string
Encode the header section of the message
encodeIPv4Address()  : string
Encode an IPv4Address field
encodeIPv6Address()  : string
Encode an IPv6Address field
encodeLong()  : string
Encode a Long field
encodeQuestionRecord()  : mixed
Encode a question record
encodeResourceRecord()  : mixed
Encode a resource record
encodeShort()  : string
Encode a Short field
encodeType()  : string
Encode a type object

Properties

Methods

encode()

Encode a Message to raw network data

public encode(Message $message[, bool $compress = true ]) : string
Parameters
$message : Message

The Message to encode

$compress : bool = true

Enable message compression

Return values
string

encodeAnything()

Encode an Anything field

private encodeAnything(Anything $anything) : string
Parameters
$anything : Anything
Return values
string

encodeBitMap()

Encode a BitMap field

private encodeBitMap(BitMap $bitMap) : string
Parameters
$bitMap : BitMap
Return values
string

encodeChar()

Encode a Char field

private encodeChar(Char $char) : string
Parameters
$char : Char
Return values
string

encodeCharacterString()

Encode a CharacterString field

private encodeCharacterString(CharacterString $characterString) : string
Parameters
$characterString : CharacterString
Return values
string

encodeHeader()

Encode the header section of the message

private encodeHeader(EncodingContext $encodingContext, Message $message) : string
Parameters
$encodingContext : EncodingContext
$message : Message
Tags
throws
UnexpectedValueException

When the header section is invalid

Return values
string

encodeIPv4Address()

Encode an IPv4Address field

private encodeIPv4Address(IPv4Address $ipv4Address) : string
Parameters
$ipv4Address : IPv4Address
Return values
string

encodeIPv6Address()

Encode an IPv6Address field

private encodeIPv6Address(IPv6Address $ipv6Address) : string
Parameters
$ipv6Address : IPv6Address
Return values
string

encodeLong()

Encode a Long field

private encodeLong(Long $long) : string
Parameters
$long : Long
Return values
string

encodeShort()

Encode a Short field

private encodeShort(Short $short) : string
Parameters
$short : Short
Return values
string

        
On this page

Search results