David Blacka > Net-BEEP-Lite-0.06 > Net::BEEP::Lite::Channel

Download:
Net-BEEP-Lite-0.06.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Source  

NAME ^

Net::BEEP::Lite::Channel - a class for holding BEEP channel variables.

DESCRIPTION ^

This is a class that basically just hold various channel related variables. Most of the actual "action" methods are in Net::BEEP::Lite::Session.

CONSTRUCTOR ^

new( ARGS )

This is the main constructor. It takes a named parameter list as its argument. See the initialize method for a list of valid parameter names.

METHODS ^

initialize( ARGS )

Initialize the object. This is generally called by the constructor and subclasses. It takes the following named parameters:

Number

The channel number.

Window

The local window to start with. Default to 4096.

Profile

The profile implementation.

profile([$val])

Sets or returns the profile implementation object assoc. with this channel (if any).

seqno()

Returns the current (sending) sequence number for this channel. Note that this is the sequence number for octets being sent to the peer.

update_seqno($length)

Adds length to the current sequence number. This is done when frames are written to the socket.

peer_seqno([$val])

Returns (or sets and returns) the peer sequence number. This is (or should be) the sequence number of the octet seen from the peer on this channel. I.e., this should get updated when frames are read from the socket. This value is primarily used in calculating SEQ frames to send back to the peer (as the ackno.).

msgno([$val])

Sets or returns the current message number for this channel.

next_msgno()

Returns the current message number, then increments it.

local_window([$val])

Sets or returns the size of the local (receiving) window. This is what gets published in sent SEQ frames for this window.

remote_window([$val])

Sets or returns the size of the remove (sending) window. This is what is used to determine the max payload size on a frame that is about to be sent.

message()

Returns the current message that is under construction by the recv_* method in Net::BEEP::Lite::Session.

message_add_frame($frame)

Adds (or create a new message with) the frame to the message under construction.

clear_message()

Clears the message under construction. This is generally done when the message is complete.

ans_message($ans_number, [$val])

Returns or sets the ANS message under construction for the given ANS number.

ans_message_add_frame($frame)

Adds a frame (or creates a new ANS message) for the ANS message under construction with the frame's ANS number.

ans_clear_message($ans_number)

Clears the ANS message under construction with the given ANS number. This is generally done when the message is complete.

number()

Returns the channel number.

SEE ALSO ^

Net::BEEP::Lite::Session
Net::BEEP::Lite::Message
syntax highlighting: