OOTCPStreamDecoder.h File Reference

#include "OOTCPStreamDecoderAbstractionLayer.h"

Include dependency graph for OOTCPStreamDecoder.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Typedefs
typedef struct OOTCPStreamDecoder *	OOTCPStreamDecoderRef
typedef void(*	OOTCPStreamDecoderPacketCallback) (void *cbInfo, OOALStringRef packetType, OOALDictionaryRef packet)
typedef void(*	OOTCPStreamDecoderErrorCallback) (void *cbInfo, OOALStringRef errorDesc)
typedef void(*	OOTCPStreamDecoderFinalizeCallback) (void *cbInfo)

Functions
OOTCPStreamDecoderRef	OOTCPStreamDecoderCreate (OOTCPStreamDecoderPacketCallback packetCB, OOTCPStreamDecoderErrorCallback errorCB, OOTCPStreamDecoderFinalizeCallback finalizeCB, void *cbInfo)
void	OOTCPStreamDecoderDestroy (OOTCPStreamDecoderRef decoder)
void	OOTCPStreamDecoderReceiveData (OOTCPStreamDecoderRef decoder, OOALDataRef data)
void	OOTCPStreamDecoderReceiveBytes (OOTCPStreamDecoderRef decoder, const void *bytes, size_t length)

Typedef Documentation

OOTCPStreamDecoderErrorCallback

typedef void(* OOTCPStreamDecoderErrorCallback) (void *cbInfo, OOALStringRef errorDesc)

Definition at line 41 of file OOTCPStreamDecoder.h.

OOTCPStreamDecoderFinalizeCallback

typedef void(* OOTCPStreamDecoderFinalizeCallback) (void *cbInfo)

Definition at line 42 of file OOTCPStreamDecoder.h.

OOTCPStreamDecoderPacketCallback

typedef void(* OOTCPStreamDecoderPacketCallback) (void *cbInfo, OOALStringRef packetType, OOALDictionaryRef packet)

Definition at line 40 of file OOTCPStreamDecoder.h.

OOTCPStreamDecoderRef

typedef struct OOTCPStreamDecoder* OOTCPStreamDecoderRef

Definition at line 38 of file OOTCPStreamDecoder.h.

Function Documentation

OOTCPStreamDecoderCreate()

OOTCPStreamDecoderRef OOTCPStreamDecoderCreate	(	OOTCPStreamDecoderPacketCallback	packetCB,
		OOTCPStreamDecoderErrorCallback	errorCB,
		OOTCPStreamDecoderFinalizeCallback	finalizeCB,
		void *	cbInfo )

Definition at line 64 of file OOTCPStreamDecoder.c.

{
    OOTCPStreamDecoderRef               decoder = NULL;
    
    if (packetCB == NULL)  return NULL;
    
    decoder = malloc(sizeof *decoder);
    if (decoder == NULL)  return NULL;
    
    decoder->headerSpaceUsed = 0;
    decoder->nextPacketData = NULL;
    decoder->nextSize = 0;
    decoder->Packet = packetCB;
    decoder->Error = errorCB;
    decoder->Finalize = finalizeCB;
    decoder->cbInfo = cbInfo;
    
    return decoder;
}

References OOTCPStreamDecoder::cbInfo, OOTCPStreamDecoder::Error, OOTCPStreamDecoder::Finalize, OOTCPStreamDecoder::headerSpaceUsed, OOTCPStreamDecoder::nextPacketData, OOTCPStreamDecoder::nextSize, and OOTCPStreamDecoder::Packet.

OOTCPStreamDecoderDestroy()

void OOTCPStreamDecoderDestroy

(

OOTCPStreamDecoderRef

decoder

)

Definition at line 85 of file OOTCPStreamDecoder.c.

{
    if (decoder == NULL)  return;
    
    if (decoder->Finalize != NULL)
    {
        decoder->Finalize(decoder->cbInfo);
    }
    
    if (decoder->nextPacketData != NULL)
    {
        OOALRelease(decoder->nextPacketData);
        decoder->nextPacketData = NULL;
    }
    
    free(decoder);
}

References OOTCPStreamDecoder::cbInfo, OOTCPStreamDecoder::Finalize, OOTCPStreamDecoder::nextPacketData, and OOALRelease().

Here is the call graph for this function:

OOTCPStreamDecoderReceiveBytes()

void OOTCPStreamDecoderReceiveBytes	(	OOTCPStreamDecoderRef	decoder,
		const void *	bytes,
		size_t	length )

Definition at line 112 of file OOTCPStreamDecoder.c.

{
    const unsigned char             *bytes = NULL;
    size_t                          remaining;
    size_t                          bytesToAdd;
    OOALAutoreleasePoolRef          pool = NULL;
    
    if (decoder == NULL)  return;
    
    bytes = inBytes;
    remaining = length;
    
    if (bytes == NULL && remaining != 0)
    {
        Error(decoder, OOALSTR("Invalid data -- NULL bytes but %u byte count."), remaining);
        return;
    }
    
    while (remaining != 0)
    {
        if (decoder->nextPacketData != NULL)
        {
            // More data expected
            bytesToAdd = remaining;
            if (decoder->nextSize < bytesToAdd)  bytesToAdd = decoder->nextSize;
            
            OOALMutableDataAppendBytes(decoder->nextPacketData, bytes, bytesToAdd);
            
            remaining -= bytesToAdd;
            decoder->nextSize -= bytesToAdd;
            bytes += bytesToAdd;
            
            if (decoder->nextSize == 0)
            {
                // Packet is ready.
                pool = OOALCreateAutoreleasePool();
                PacketReady(decoder);
                OOALDestroyAutoreleasePool(pool);
                pool = NULL;
                
                OOALRelease(decoder->nextPacketData);
                decoder->nextPacketData = NULL;
            }
        }
        else if (decoder->headerSpaceUsed < 4)
        {
            // Read bytes for packet header
            remaining--;
            decoder->header[decoder->headerSpaceUsed++] = *bytes++;
        }
        else if (decoder->headerSpaceUsed == 4)
        {
            // We've read a header, start on a packet.
            decoder->nextSize = (decoder->header[0] << 24) |
                                (decoder->header[1] << 16) |
                                (decoder->header[2] << 8) |
                                (decoder->header[3] << 0);
            
            decoder->headerSpaceUsed = 0;
            if (decoder->nextSize != 0)
            {
                decoder->nextPacketData = OOALDataCreateMutable(decoder->nextSize);
            }
        }
        else
        {
            Error(decoder, OOALSTR("OOTCPStreamDecoder internal error: reached unreachable state. nextSize = %lu, bufferUsed = %lu, nextPacketData = %@."), (unsigned long)decoder->nextSize, (unsigned long)decoder->headerSpaceUsed, decoder->nextPacketData);
        }
    }
}

References Error(), OOTCPStreamDecoder::header, OOTCPStreamDecoder::headerSpaceUsed, OOTCPStreamDecoder::nextPacketData, OOTCPStreamDecoder::nextSize, OOALCreateAutoreleasePool(), OOALDataCreateMutable(), OOALDestroyAutoreleasePool, OOALMutableDataAppendBytes(), OOALRelease(), OOALSTR, and PacketReady().

Referenced by OOTCPStreamDecoderReceiveData().

Here is the call graph for this function:

Here is the caller graph for this function:

OOTCPStreamDecoderReceiveData()

void OOTCPStreamDecoderReceiveData	(	OOTCPStreamDecoderRef	decoder,
		OOALDataRef	data )

Definition at line 104 of file OOTCPStreamDecoder.c.

{
    if (decoder == NULL || data == NULL)  return;
    
    OOTCPStreamDecoderReceiveBytes(decoder, OOALDataGetBytePtr(data), OOALDataGetLength(data));
}

References OOALDataGetBytePtr(), OOALDataGetLength(), and OOTCPStreamDecoderReceiveBytes().

Here is the call graph for this function: