Docs For Class Net_DIME

$cf = 0

[line 362]

Type:

mixed

[ Top ]

$currentPart = -1

[line 354]

Type:

mixed

[ Top ]

$debug = false

[line 364]

Type:

mixed

[ Top ]

$id = null

[line 363]

Type:

mixed

[ Top ]

$mb = 1

[line 360]

Type:

mixed

[ Top ]

$me = 0

[line 361]

Type:

mixed

[ Top ]

$parts = array()

[line 353]

Type:

mixed

[ Top ]

$record_size = 4096

[line 352]

Type:

mixed

[ Top ]

$stream = null

[line 355]

Type:

mixed

[ Top ]

$type =

[line 358]

Type:

mixed

[ Top ]

$typestr =

[line 359]

Type:

mixed

[ Top ]

Net_DIME_Message (Constructor) [line 375]

Net_DIME_Message Net_DIME_Message(
[resource
$stream = null], [integer
$record_size = 4096], [boolean
$debug = false])

Constructor.

Todo: Integrate with PHP streams.

Parameters:

resource	`$stream`	—	A file pointer.
integer	`$record_size`	—
boolean	`$debug`	—

[ Top ]

decodeData [line 631]

void decodeData(

$data)

Decodes a DIME encode string of data.

Parameters:

$data —

[ Top ]

doChunk [line 423]

void doChunk(

$data)

Parameters:

$data —

[ Top ]

encodeData [line 528]

void encodeData(
string
$data, [string
$typestr = ''], [string
$id = null], [integer
$type = NET_DIME_TYPE_UNKNOWN])

Encodes data in DIME.

Parameters:

string	`$data`	—
string	`$typestr`	—
string	`$id`	—
integer	`$type`	—	One of the NET_DIME_TYPE_* constants.

[ Top ]

encodeFile [line 556]

void encodeFile(

$filename, [
$typestr = ''], [
$id = null], [
$type = NET_DIME_TYPE_UNKNOWN])

Reads a file, creates records and writes them to the stream provided in the constructor.

Parameters:

	`$filename`	—
	`$typestr`	—
	`$id`	—
	`$type`	—

[ Top ]

endChunk [line 431]

void endChunk(
)

[ Top ]

endMessage [line 445]

void endMessage(
)

[ Top ]

read [line 649]

void read(
[
$buf = null])

Reads the stream and creates an array of records.

The method can accept the start of a previously read buffer. This is useful in situations where you need to read headers before discovering that the data is DIME encoded, such as in the case of reading an HTTP response.

Parameters:

$buf —

[ Top ]

sendData [line 466]

void sendData(
string
$data, [string
$typestr = ''], [string
$id = null], [integer
$type = NET_DIME_TYPE_UNKNOWN])

Creates DIME records from a chunk of data and writes them to the stream provided in the constructor.

Parameters:

string	`$data`	—
string	`$typestr`	—
string	`$id`	—
integer	`$type`	—	One of the NET_DIME_TYPE_* constants.

[ Top ]

sendEndMessage [line 489]

void sendEndMessage(
)

[ Top ]

sendFile [line 504]

void sendFile(
string
$filename, [string
$typestr = ''], [string
$id = null], [integer
$type = NET_DIME_TYPE_UNKNOWN])

Reads a file, creates records and writes them to the stream provided in the constructor.

Parameters:

string	`$filename`	—	A file name.
string	`$typestr`	—
string	`$id`	—
integer	`$type`	—	One of the NET_DIME_TYPE_* constants.

[ Top ]

startChunk [line 407]

void startChunk(

$data, [
$typestr = ''], [
$id = null], [
$type = NET_DIME_TYPE_UNKNOWN])

Parameters:

	`$data`	—
	`$typestr`	—
	`$id`	—
	`$type`	—

[ Top ]

Class: Net_DIME_Message

Class Overview

Author(s):

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$cf = 0

$currentPart = -1

$debug = false

$id = null

$mb = 1

$me = 0

$parts = array()

$record_size = 4096

$stream = null

$type =

$typestr =

Method Detail

Net_DIME_Message (Constructor) [line 375]

Parameters:

decodeData [line 631]

Parameters:

doChunk [line 423]

Parameters:

encodeData [line 528]

Parameters:

encodeFile [line 556]

Parameters:

endChunk [line 431]

endMessage [line 445]

read [line 649]

Parameters:

sendData [line 466]

Parameters:

sendEndMessage [line 489]

sendFile [line 504]

Parameters:

startChunk [line 407]

Parameters: