Decoding


Detailed Description


Functions

int kate_decode_is_idheader (const kate_packet *kp)
int kate_decode_headerin (kate_info *ki, kate_comment *kc, kate_packet *kp)
int kate_decode_init (kate_state *k, kate_info *ki)
int kate_decode_packetin (kate_state *k, kate_packet *kp)
int kate_decode_eventout (kate_state *k, kate_const kate_event **event)


Function Documentation

int kate_decode_eventout ( kate_state k,
kate_const kate_event **  event 
)

Requests a pointer to the event decoded by the last packet, if there is one.

Parameters:
k the kate_state to get the event from
event a pointer to where to place the pointer to the event, if any
Returns:
0 success, an event was returned

1 success, but there was no event to return

KATE_E_* error

int kate_decode_headerin ( kate_info ki,
kate_comment kc,
kate_packet kp 
)

Decodes a header packet, and updates the kate_info and kate_comment structures from the decoded data.

Parameters:
ki the kate_info structure to update
kc the kate_comment structure to update
kp the packet to decode
Returns:
0 success

1 success, and all headers have been decoded

KATE_E_* error

int kate_decode_init ( kate_state k,
kate_info ki 
)

Initializes a kate_state structure for decoding using the supplied kate_info structure. When done, the kate_state should be cleared using kate_clear.

Parameters:
k the kate_state to initialize for decoding
ki the kate_info structure initialized from the decoded headers
Returns:
0 success

KATE_E_* error

int kate_decode_is_idheader ( const kate_packet kp  ) 

Checks if a packet is a Kate ID header

Parameters:
kp the packet to inspect
Returns:
0 the packet is not an ID header

!=0 the packet is an ID header

int kate_decode_packetin ( kate_state k,
kate_packet kp 
)

Decodes a data packet.

Parameters:
k the kate_state to decode to
kp the packet to decode
Returns:
0 success

1 success, and we're at end of stream

KATE_E_* error


Generated on Sun Oct 5 18:01:01 2008 for libkate by  doxygen 1.5.4