Docs For Class docsis_ether_packet

Description

DOCSIS Ethernet Packet Classifier

Located in /docsis_config/docsis_classifier.php (line 191)

docsis_encoder
   |
   --docsis_encoder_complex
      |
      --docsis_ether_packet_classifier

Method Summary

docsis_ether_packet_classifier docsis_ether_packet_classifier ([int $code = DOCSIS_PACKET_CLASSIFIER_ETHERNET], [array $value = array()])

void set_dest_mac (string $mac)

void set_dsap_type (int $type, int $eprot1, int $eprot2)

void set_source_mac (string $mac)

Variables

Inherited Variables

Inherited from docsis_encoder

docsis_encoder::$code
docsis_encoder::$value

Methods

Constructor docsis_ether_packet_classifier (line 199)

Constructor

docsis_ether_packet_classifier docsis_ether_packet_classifier ([int $code = DOCSIS_PACKET_CLASSIFIER_ETHERNET], [array $value = array()])

int $code: docsis code
array $value: predefined values

set_dest_mac (line 209)

Set Destination MAC Address - docsis 1.1

void set_dest_mac (string $mac)

string $mac

set_dsap_type (line 258)

Set Ethernet/DSAP/MacType - docsis 1.1

$type, $eprot1, and $eprot2 indicate the format of the layer 3 protocol ID in the Ethernet packet as follows:

If $type is 0, the rule does not use layer 3 protocol type as a matching criteria. $eprot1 and $eprot2 are ignored.

If $type is 1, the rule applies only to frames with contain an Ethertype value. Ethertype values are contained in packets using the DEC-Intel-Xeros (DIX) encapsulation or the RFC-1042 Sub-Network Access Protocol (SNAP) encapsulation formats. $eprot1 and $eprot2 give the 16-bit value of the Ethertype that the packet must match in order to match the rule.

If $type is 2, the rule applies only to frames using the IEEE 802.2 encapsulation format with a Destination Service (DSAP) other than 0xAA (which is reserved for SNAP). The lower 8 bits of $eprot1,$eprot2 must match the DSAP byte of the packet in order to match the rule.

If $type is 3, the rule applies only to MAC Management Messages (FC field 1100001x) with a "type" field of its MAC Management Message header between the values of $eprot1 and $eprot2, inclusive. As exceptions, the following MAC Management message types must not be classified, and are always transmitted on the primary service flow:

Type 4: RNG_REQ
Type 6: REG_REQ
Type 7: REG_RSP
Type 14: REG_ACK

If $type is 4, the rule is considered a "catch-all" rule that matches all Data PDU packets. The rule does not match MAC Management Messages. $eprot1 and $eprot2 are ignored.

If the Ethernet frame contains an 802.1P/Q Tag Header (i.e., Ethertype 0x8100), this object applies to the embedded Ethertype field within the 802.1P/Q header.

void set_dsap_type (int $type, int $eprot1, int $eprot2)

int $type
int $eprot1
int $eprot2

set_source_mac (line 219)

Set Source MAC Address - docsis 1.1

void set_source_mac (string $mac)

string $mac

Inherited Methods

Inherited From docsis_encoder_complex

docsis_encoder_complex::docis_encoder_complex()
docsis_encoder_complex::encode()

Inherited From docsis_encoder

docsis_encoder::docsis_encoder()
docsis_encoder::encode()