Docs For Class docsis_ip_packet

Description

DOCSIS IP Packet Classifier

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

docsis_encoder
   |
   --docsis_encoder_complex
      |
      --docsis_ip_packet_classifier

Method Summary

docsis_ip_packet_classifier docsis_ip_packet_classifier ([int $code = DOCSIS_PACKET_CLASSIFIER_IP_PACKET], [array $value = array()])

void set_dest_address (string $ip)

void set_dest_mask (string $mask)

void set_dest_port_end (int $end)

void set_dest_port_start (int $start)

void set_protocol (int $value)

void set_source_address (string $ip)

void set_source_mask (string $mask)

void set_source_port_end (int $end)

void set_source_port_start (int $start)

void set_type_of_service (int $low, int $high, int $mask)

Variables

Inherited Variables

Inherited from docsis_encoder

docsis_encoder::$code
docsis_encoder::$value

Methods

Constructor docsis_ip_packet_classifier (line 61)

Constructor

docsis_ip_packet_classifier docsis_ip_packet_classifier ([int $code = DOCSIS_PACKET_CLASSIFIER_IP_PACKET], [array $value = array()])

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

set_dest_address (line 126)

Set Destination Address - docsis 1.1

void set_dest_address (string $ip)

string $ip

set_dest_mask (line 136)

Set Destination Mask - docsis 1.1

void set_dest_mask (string $mask)

string $mask

set_dest_port_end (line 179)

Set TCP/UDP Destination Port End - docsis 1.1

void set_dest_port_end (int $end)

int $end

set_dest_port_start (line 168)

Set TCP/UDP Destination Port Start - docsis 1.1

void set_dest_port_start (int $start)

int $start

set_protocol (line 95)

Set Protocol - docsis 1.1

The value of the field specifies the matching value for the IP Protocol field (RFC-1700). If this parameter is ommitted, then comparison of the IP header Protocol field is irrelevant.

There are two special IP Protocol field values: "256" matches traffic with any IP Protocol value, and "257" matches both TCP and UDP traffic. An entry that includes an IP Protocol field value greater than 257 must be invalidated for comparisons (i.e., no traffic can match this entry).

void set_protocol (int $value)

int $value

set_source_address (line 106)

Set IP Source Address - docsis 1.1

void set_source_address (string $ip)

string $ip

set_source_mask (line 116)

Set IP Source Mask - docsis 1.1

void set_source_mask (string $mask)

string $mask

set_source_port_end (line 157)

Set TCP/UDP Source Port End - docsis 1.1

void set_source_port_end (int $end)

int $end

set_source_port_start (line 146)

Set TCP/UDP Source Port Start - docsis 1.1

void set_source_port_start (int $start)

int $start

set_type_of_service (line 77)

Set Type of Service - docsis 1.1

The values of the field specify the matching parameters for the IP ToS byte rand and mask. An IP packet with IP ToS byte value "ip-tos" matches this parameter if $low <= (ip-tos AND $mask) <= $high. If this field is ommitted, then comparison of IP packet ToS byte for this entry is irrelavant.

void set_type_of_service (int $low, int $high, int $mask)

int $low
int $high
int $mask

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()