OOTCPStreamDecoder.c File Reference

#include "OOTCPStreamDecoder.h"
#include <stdlib.h>
#include <stdarg.h>
#include <stdint.h>
#include "OODebugTCPConsoleProtocol.h"

Include dependency graph for OOTCPStreamDecoder.c:

Go to the source code of this file.

Classes
struct	OOTCPStreamDecoder

Macros
#define	LogOOTCPStreamDecoderPacket(packet)

Functions
static void	Error (OOTCPStreamDecoderRef decoder, OOALStringRef format,...)
static void	PacketReady (OOTCPStreamDecoderRef decoder)
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 *inBytes, size_t length)

Macro Definition Documentation

LogOOTCPStreamDecoderPacket

#define LogOOTCPStreamDecoderPacket

(

packet

)

Value:

do {} while (0)

Definition at line 41 of file OOTCPStreamDecoder.c.

Referenced by PacketReady().

Function Documentation

Error()

void Error ( OOTCPStreamDecoderRef decoder, OOALStringRef format, ... )

static

Definition at line 227 of file OOTCPStreamDecoder.c.

{
    va_list                         args;
    OOALStringRef                  string = NULL;
    
    if (decoder == NULL || decoder->Error == NULL || format == NULL)  return;
    
    va_start(args, format);
    string = OOALStringCreateWithFormatAndArguments(format, args);
    va_end(args);
    
    if (string != NULL)
    {
        decoder->Error(decoder->cbInfo, string);
        OOALRelease(string);
    }
}

References OOTCPStreamDecoder::cbInfo, OOTCPStreamDecoder::Error, OOALRelease(), and OOALStringCreateWithFormatAndArguments().

Referenced by OOTCPStreamDecoderReceiveBytes(), and PacketReady().

Here is the call graph for this function:

Here is the caller graph for this function:

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.

Referenced by OODebugTCPConsoleClient::initWithAddress:port:.

Here is the caller graph for this function:

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

Referenced by OODebugTCPConsoleClient::dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

OOTCPStreamDecoderReceiveBytes()

void OOTCPStreamDecoderReceiveBytes	(	OOTCPStreamDecoderRef	decoder,
		const void *	inBytes,
		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().

Referenced by OODebugTCPConsoleClient(OOPrivate)::readData.

Here is the call graph for this function:

Here is the caller graph for this function:

PacketReady()

void PacketReady ( OOTCPStreamDecoderRef decoder )

static

Definition at line 184 of file OOTCPStreamDecoder.c.

{
    OOALDictionaryRef                  packet = NULL;
    OOALStringRef                      errorString = NULL;
    OOALStringRef                      packetType = NULL;
    
    packet = OOALPropertyListFromData(decoder->nextPacketData, &errorString);
    
    // Ensure that it's a property list.
    if (packet == NULL)
    {
        Error(decoder, OOALSTR("Protocol error: packet is not property list (property list error: %@)."), errorString);
        OOALRelease(errorString);
        return;
    }
    
    // Ensure that it's a dictionary.
    if (!OOALIsDictionary(packet))
    {
        Error(decoder, OOALSTR("Protocol error: packet is a %@, not a dictionary."), OOTypeDescription(packet));
        return;
    }
    
    LogOOTCPStreamDecoderPacket(packet);
    
    // Get packet type (and ensure that there is one).
    packetType = OOALDictionaryGetValue(packet, kOOTCPPacketType);
    if (packetType == NULL)
    {
        Error(decoder, OOALSTR("Protocol error: packet contains no packet type."));
        return;
    }
    
    if (!OOALIsString(packetType))
    {
        Error(decoder, OOALSTR("Protocol error: packet type is a %@, not a string."), OOTypeDescription(packetType));
        return;
    }
    
    decoder->Packet(decoder->cbInfo, packetType, packet);
}

References OOTCPStreamDecoder::cbInfo, Error(), kOOTCPPacketType, LogOOTCPStreamDecoderPacket, OOTCPStreamDecoder::nextPacketData, OOALDictionaryGetValue(), OOALIsDictionary(), OOALIsString(), OOALPropertyListFromData(), OOALRelease(), OOALSTR, OOTypeDescription(), and OOTCPStreamDecoder::Packet.

Referenced by OOTCPStreamDecoderReceiveBytes().

Here is the call graph for this function:

Here is the caller graph for this function: