#include <OODebugTCPConsoleClient.h>

Inheritance diagram for OODebugTCPConsoleClient:

Collaboration diagram for OODebugTCPConsoleClient:

Instance Methods
(id)	- initWithAddress:port:

(id)	- init `[implementation]`

(void)	- dealloc `[implementation]`

(BOOL)	- connectDebugMonitor:errorMessage: `[implementation]`

(void)	- disconnectDebugMonitor:message: `[implementation]`

(oneway void)	- debugMonitor:jsConsoleOutput:colorKey:emphasisRange: `[implementation]`

(oneway void)	- debugMonitorClearConsole: `[implementation]`

(oneway void)	- debugMonitorShowConsole: `[implementation]`

(oneway void)	- debugMonitor:noteConfiguration: `[implementation]`

(oneway void)	- debugMonitor:noteChangedConfigrationValue:forKey: `[implementation]`

(void)	- stream:handleEvent: `[implementation]`

(void)	- closeConnection `[implementation]`

(BOOL)	- sendBytes:count: `[implementation]`

(void)	- sendDictionary: `[implementation]`

(void)	- sendPacket:withParameters: `[implementation]`

(void)	- sendPacket:withValue:forParameter: `[implementation]`

(void)	- readData `[implementation]`

(void)	- dispatchPacket:ofType: `[implementation]`

(void)	- handleApproveConnectionPacket: `[implementation]`

(void)	- handleRejectConnectionPacket: `[implementation]`

(void)	- handleCloseConnectionPacket: `[implementation]`

(void)	- handleNoteConfigurationChangePacket: `[implementation]`

(void)	- handlePerformCommandPacket: `[implementation]`

(void)	- handleRequestConfigurationValuePacket: `[implementation]`

(void)	- handlePingPacket: `[implementation]`

(void)	- handlePongPacket: `[implementation]`

(void)	- disconnectFromServerWithMessage: `[implementation]`

(void)	- breakConnectionWithMessage: `[implementation]`

(void)	- breakConnectionWithBadStream: `[implementation]`

Private Attributes
NSHost *	_host

NSOutputStream *	_outStream

NSInputStream *	_inStream

OOTCPClientConnectionStatus	_status

OODebugMonitor *	_monitor

struct OOTCPStreamDecoder *	_decoder

Detailed Description

Definition at line 47 of file OODebugTCPConsoleClient.h.

Method Documentation

◆ breakConnectionWithBadStream:

- (void) breakConnectionWithBadStream: (NSStream *) stream

implementation

Provided by category OODebugTCPConsoleClient(OOPrivate).

Definition at line 681 of file OODebugTCPConsoleClient.m.

                                     :(NSStream *)stream
{
    NSString                *errorDesc = nil;
    NSError                 *error = nil;
    
    error = [stream streamError];
    errorDesc = [error localizedDescription];
    if (errorDesc == nil)  errorDesc = [error description];
    if (errorDesc == nil)  errorDesc = @"bad stream.";
    [self breakConnectionWithMessage:[NSString stringWithFormat:
       @"Connection to debug console failed: '%@' (outStream status: %li, inStream status: %li).",
        errorDesc, [_outStream streamStatus], [_inStream streamStatus]]];
}

Referenced by OODebugTCPConsoleClient(OOPrivate)::sendDictionary:, and stream:handleEvent:.

Here is the caller graph for this function:

◆ breakConnectionWithMessage:

- (void) breakConnectionWithMessage: (NSString *) message

implementation

Provided by category OODebugTCPConsoleClient(OOPrivate).

Definition at line 658 of file OODebugTCPConsoleClient.m.

                                   :(NSString *)message
{
    [self closeConnection];
    
    if (_status != kOOTCPClientConnectionRefused)  _status = kOOTCPClientDisconnected;
    
    if ([message length] > 0)
    {
        OOLog(@"debugTCP.disconnect", @"No connection to debug console: \"%@\"", message);
    }
    else
    {
        OOLog(@"debugTCP.disconnect", @"%@", @"Debug console not connected."); 
    }
    
#if 0
    // Disconnecting causes crashiness for reasons I don't understand, and isn't very important anyway.
    [_monitor disconnectDebugger:self message:message];
    _monitor = nil;
#endif
}

Referenced by OODebugTCPConsoleClient(OOPrivate)::breakConnectionWithBadStream:, DecoderError(), OODebugTCPConsoleClient(OOPrivate)::handleCloseConnectionPacket:, OODebugTCPConsoleClient(OOPrivate)::handleRejectConnectionPacket:, and stream:handleEvent:.

Here is the caller graph for this function:

◆ closeConnection

- (void) closeConnection

implementation

Provided by category OODebugTCPConsoleClient(OOPrivate).

Definition at line 322 of file OODebugTCPConsoleClient.m.

{
    [_inStream close];
    [_inStream setDelegate:nil];
    [_inStream release];
    _inStream = nil;
    
    [_outStream close];
    [_outStream setDelegate:nil];
    [_outStream release];
    _outStream = nil;
    
    [_host release];
    _host = nil;
}

Referenced by OODebugTCPConsoleClient(OOPrivate)::breakConnectionWithMessage:, dealloc, and OODebugTCPConsoleClient(OOPrivate)::disconnectFromServerWithMessage:.

Here is the caller graph for this function:

◆ connectDebugMonitor:errorMessage:

- (BOOL) connectDebugMonitor:		(in OODebugMonitor *)	debugMonitor
errorMessage:		(out NSString **)	message

implementation

Reimplemented from <OODebuggerInterface>.

Definition at line 203 of file OODebugTCPConsoleClient.m.

                           :(in OODebugMonitor *)debugMonitor
               errorMessage:(out NSString **)message
{
    if (_status == kOOTCPClientConnectionRefused)
    {
        if (message != NULL)  *message = @"Connection refused.";
        return NO;
    }
    if (_status == kOOTCPClientDisconnected)
    {
        if (message != NULL)  *message = @"Cannot reconnect after disconnecting.";
        return NO;
    }
    
    _monitor = debugMonitor;
    
    return YES;
}

References _monitor, _status, kOOTCPClientConnectionRefused, and kOOTCPClientDisconnected.

◆ dealloc

- (void) dealloc

implementation

Definition at line 182 of file OODebugTCPConsoleClient.m.

{
    if (StatusIsSendable(_status))
    {
        [self disconnectFromServerWithMessage:@"TCP console bridge unexpectedly released while active."];
    }
    if (_monitor)
    {
        [_monitor disconnectDebugger:self message:@"TCP console bridge unexpectedly released while active."];
    }
    
    
    [self closeConnection];
    
    OOTCPStreamDecoderDestroy(_decoder);
    _decoder = NULL;
    
    [super dealloc];
}

References _decoder, _monitor, _status, closeConnection, dealloc, OODebugMonitor::disconnectDebugger:message:, disconnectFromServerWithMessage:, OOTCPStreamDecoderDestroy(), and StatusIsSendable().

Referenced by dealloc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ debugMonitor:jsConsoleOutput:colorKey:emphasisRange:

- (oneway void) debugMonitor:	(in OODebugMonitor *)	debugMonitor
jsConsoleOutput:	(in NSString *)	output
colorKey:	(in NSString *)	colorKey
emphasisRange:	(in NSRange)	emphasisRange

implementation

Reimplemented from <OODebuggerInterface>.

Definition at line 231 of file OODebugTCPConsoleClient.m.

                           :(in OODebugMonitor *)debugMonitor
            jsConsoleOutput:(in NSString *)output
                   colorKey:(in NSString *)colorKey
              emphasisRange:(in NSRange)emphasisRange
{
    NSMutableDictionary         *parameters = nil;
    NSArray                     *range = nil;
    
    parameters = [NSMutableDictionary dictionaryWithCapacity:3];
    [parameters setObject:output forKey:kOOTCPMessage];
    [parameters setObject:colorKey ? colorKey : (NSString *)@"general" forKey:kOOTCPColorKey];
    if (emphasisRange.length != 0)
    {
        range = [NSArray arrayWithObjects:
                        [NSNumber numberWithUnsignedInteger:emphasisRange.location],
                        [NSNumber numberWithUnsignedInteger:emphasisRange.length],
                        nil];
        [parameters setObject:range forKey:kOOTCPEmphasisRanges];
    }
    
    [self sendPacket:kOOTCPPacket_ConsoleOutput
       withParameters:parameters];
}

References nil, and sendPacket:withParameters:.

Here is the call graph for this function:

◆ debugMonitor:noteChangedConfigrationValue:forKey:

- (oneway void) debugMonitor:	(in OODebugMonitor *)	debugMonitor
noteChangedConfigrationValue:	(in id)	newValue
forKey:	(in NSString *)	key

implementation

Reimplemented from <OODebuggerInterface>.

Definition at line 279 of file OODebugTCPConsoleClient.m.

                           :(in OODebugMonitor *)debugMonitor
noteChangedConfigrationValue:(in id)newValue
                     forKey:(in NSString *)key
{
    if (newValue != nil)
    {
        [self sendPacket:kOOTCPPacket_NoteConfiguration
                withValue:[NSDictionary dictionaryWithObject:newValue forKey:key]
             forParameter:kOOTCPConfiguration];
    }
    else
    {
        [self sendPacket:kOOTCPPacket_NoteConfiguration
                withValue:[NSArray arrayWithObject:key]
             forParameter:kOOTCPRemovedConfigurationKeys];
    }
}

References nil, and sendPacket:withValue:forParameter:.

Referenced by OODebugTCPConsoleClient(OOPrivate)::handleRequestConfigurationValuePacket:.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ debugMonitor:noteConfiguration:

- (oneway void) debugMonitor:		(in OODebugMonitor *)	debugMonitor
noteConfiguration:		(in NSDictionary *)	configuration

implementation

Reimplemented from <OODebuggerInterface>.

Definition at line 270 of file OODebugTCPConsoleClient.m.

                           :(in OODebugMonitor *)debugMonitor
          noteConfiguration:(in NSDictionary *)configuration
{
    [self sendPacket:kOOTCPPacket_NoteConfiguration
            withValue:configuration
         forParameter:kOOTCPConfiguration];
}

References sendPacket:withValue:forParameter:.

Here is the call graph for this function:

◆ debugMonitorClearConsole:

- (oneway void) debugMonitorClearConsole: (in OODebugMonitor *) debugMonitor

implementation

Reimplemented from <OODebuggerInterface>.

Definition at line 256 of file OODebugTCPConsoleClient.m.

                                       :(in OODebugMonitor *)debugMonitor
{
    [self sendPacket:kOOTCPPacket_ClearConsole
       withParameters:nil];
}

References sendPacket:withParameters:.

Here is the call graph for this function:

◆ debugMonitorShowConsole:

- (oneway void) debugMonitorShowConsole: (in OODebugMonitor *) debugMonitor

implementation

Reimplemented from <OODebuggerInterface>.

Definition at line 263 of file OODebugTCPConsoleClient.m.

                                      :(in OODebugMonitor *)debugMonitor
{
    [self sendPacket:kOOTCPPacket_ShowConsole
       withParameters:nil];
}

References sendPacket:withParameters:.

Here is the call graph for this function:

◆ disconnectDebugMonitor:message:

- (void) disconnectDebugMonitor:		(in OODebugMonitor *)	debugMonitor
message:		(in NSString *)	message

implementation

Reimplemented from <OODebuggerInterface>.

Definition at line 223 of file OODebugTCPConsoleClient.m.

                              :(in OODebugMonitor *)debugMonitor
                       message:(in NSString *)message
{
    [self disconnectFromServerWithMessage:message];
    _monitor = nil;
}

References _monitor, disconnectFromServerWithMessage:, and nil.

Here is the call graph for this function:

◆ disconnectFromServerWithMessage:

- (void) disconnectFromServerWithMessage: (NSString *) message

implementation

Provided by category OODebugTCPConsoleClient(OOPrivate).

Definition at line 644 of file OODebugTCPConsoleClient.m.

                                        :(NSString *)message
{
    if (StatusIsSendable(_status))
    {
        [self sendPacket:kOOTCPPacket_CloseConnection
                withValue:message
             forParameter:kOOTCPMessage];
    }
    [self closeConnection];
    
    _status = kOOTCPClientDisconnected;
}

Referenced by dealloc, and disconnectDebugMonitor:message:.

Here is the caller graph for this function:

◆ dispatchPacket:ofType:

- (void) dispatchPacket:		(NSDictionary *)	packet
ofType:		(NSString *)	packetType

implementation

Provided by category OODebugTCPConsoleClient(OOPrivate).

Definition at line 485 of file OODebugTCPConsoleClient.m.

                       :(NSDictionary *)packet ofType:(NSString *)packetType
{
    if (packet == nil || packetType == nil)  return;
    
#define PACKET_CASE(x) else if ([packetType isEqualToString:kOOTCPPacket_##x])  { [self handle##x##Packet:packet]; }
    
    if (0) {}
    PACKET_CASE(ApproveConnection)
    PACKET_CASE(RejectConnection)
    PACKET_CASE(CloseConnection)
    PACKET_CASE(NoteConfigurationChange)
    PACKET_CASE(PerformCommand)
    PACKET_CASE(RequestConfigurationValue)
    PACKET_CASE(Ping)
    PACKET_CASE(Pong)
    else
    {
        OOLog(@"debugTCP.protocolError.unknownPacketType", @"Unhandled packet type %@.", packetType);
    }
}

Referenced by DecoderPacket().

Here is the caller graph for this function:

◆ handleApproveConnectionPacket:

- (void) handleApproveConnectionPacket: (NSDictionary *) packet

implementation

Provided by category OODebugTCPConsoleClient(OOPrivate).

Definition at line 507 of file OODebugTCPConsoleClient.m.

                                      :(NSDictionary *)packet
{
    NSMutableString         *connectedMessage = nil;
    NSString                *consoleIdentity = nil;
    NSString                *hostName = nil;
    
    if (_status == kOOTCPClientStartedConnectionStage2)
    {
        _status = kOOTCPClientConnected;
        
        // Build "Connected..." message with two optional parts, console identity and host name.
        connectedMessage = [NSMutableString stringWithString:@"Connected to debug console"];
        
        consoleIdentity = [packet oo_stringForKey:kOOTCPConsoleIdentity];
        if (consoleIdentity != nil)  [connectedMessage appendFormat:@" \"%@\"", consoleIdentity];
        
        hostName = [_host name];
        if ([hostName length] != 0 &&
            ![hostName isEqual:@"localhost"] &&
            ![hostName isEqual:@"127.0.0.1"] &&
            ![hostName isEqual:@"::1"])
        {
            [connectedMessage appendFormat:@" at %@", hostName];
        }
        
        OOLog(@"debugTCP.connected", @"%@.", connectedMessage);
    }
    else
    {
        OOLog(@"debugTCP.protocolError.outOfOrder", @"Got %@ packet from debug console in wrong context.", kOOTCPPacket_ApproveConnection);
    }   
}

◆ handleCloseConnectionPacket:

- (void) handleCloseConnectionPacket: (NSDictionary *) packet

implementation

Provided by category OODebugTCPConsoleClient(OOPrivate).

Definition at line 560 of file OODebugTCPConsoleClient.m.

                                    :(NSDictionary *)packet
{
    NSString                *message = nil;
    
    if (!StatusIsSendable(_status))
    {
        OOLog(@"debugTCP.protocolError.outOfOrder", @"Got %@ packet from debug console in wrong context.", kOOTCPPacket_CloseConnection);
    }
    message = [packet oo_stringForKey:kOOTCPMessage];
    if (message == nil)  message = @"Console closed connection.";
    [self breakConnectionWithMessage:message];
}

◆ handleNoteConfigurationChangePacket:

- (void) handleNoteConfigurationChangePacket: (NSDictionary *) packet

implementation

Provided by category OODebugTCPConsoleClient(OOPrivate).

Definition at line 574 of file OODebugTCPConsoleClient.m.

                                            :(NSDictionary *)packet
{
    NSDictionary            *configuration = nil;
    NSArray                 *removed = nil;
    NSEnumerator            *keyEnum = nil;
    NSString                *key = nil;
    id                      value = nil;
    
    if (_monitor == nil)  return;
    
    configuration = [packet oo_dictionaryForKey:kOOTCPConfiguration];
    if (configuration != nil)
    {
        for (keyEnum = [configuration keyEnumerator]; (key = [keyEnum nextObject]); )
        {
            value = [configuration objectForKey:key];
            [_monitor setConfigurationValue:value forKey:key];
        }
    }
    
    removed = [configuration oo_arrayForKey:kOOTCPRemovedConfigurationKeys];
    for (keyEnum = [removed objectEnumerator]; (key = [keyEnum nextObject]); )
    {
        [_monitor setConfigurationValue:nil forKey:key];
    }
}

◆ handlePerformCommandPacket:

- (void) handlePerformCommandPacket: (NSDictionary *) packet

implementation

Provided by category OODebugTCPConsoleClient(OOPrivate).

Definition at line 602 of file OODebugTCPConsoleClient.m.

                                   :(NSDictionary *)packet
{
    NSString                *message = nil;
    
    message = [packet oo_stringForKey:kOOTCPMessage];
    if (message != nil)  [_monitor performJSConsoleCommand:message];
}

◆ handlePingPacket:

- (void) handlePingPacket: (NSDictionary *) packet

implementation

Provided by category OODebugTCPConsoleClient(OOPrivate).

Definition at line 627 of file OODebugTCPConsoleClient.m.

                         :(NSDictionary *)packet
{
    id                      message = nil;
    
    message = [packet objectForKey:kOOTCPMessage];
    [self sendPacket:kOOTCPPacket_Pong
            withValue:message
         forParameter:kOOTCPMessage];
}

◆ handlePongPacket:

- (void) handlePongPacket: (NSDictionary *) packet

implementation

Provided by category OODebugTCPConsoleClient(OOPrivate).

Definition at line 638 of file OODebugTCPConsoleClient.m.

638 :(NSDictionary *)packet

639{

640 // Do nothing; we don't currently send pings.

641}

◆ handleRejectConnectionPacket:

- (void) handleRejectConnectionPacket: (NSDictionary *) packet

implementation

Provided by category OODebugTCPConsoleClient(OOPrivate).

Definition at line 541 of file OODebugTCPConsoleClient.m.

                                     :(NSDictionary *)packet
{
    NSString                *message = nil;
    
    if (_status == kOOTCPClientStartedConnectionStage2)
    {
        _status = kOOTCPClientConnectionRefused;
    }
    else
    {
        OOLog(@"debugTCP.protocolError.outOfOrder", @"Got %@ packet from debug console in wrong context.", kOOTCPPacket_RejectConnection);
    }
    
    message = [packet oo_stringForKey:kOOTCPMessage];
    if (message == nil)  message = @"Console refused connection.";
    [self breakConnectionWithMessage:message];
}

◆ handleRequestConfigurationValuePacket:

- (void) handleRequestConfigurationValuePacket: (NSDictionary *) packet

implementation

Provided by category OODebugTCPConsoleClient(OOPrivate).

Definition at line 611 of file OODebugTCPConsoleClient.m.

                                              :(NSDictionary *)packet
{
    NSString                *key = nil;
    id                      value = nil;
    
    key = [packet oo_stringForKey:kOOTCPConfigurationKey];
    if (key != nil)
    {
        value = [_monitor configurationValueForKey:key];
        [self debugMonitor:_monitor
 noteChangedConfigrationValue:value
                    forKey:key];
    }
}

◆ init

- (id) init

implementation

Definition at line 103 of file OODebugTCPConsoleClient.m.

104{

105 return [self initWithAddress:nil port:0];

106}

References init, and initWithAddress:port:.

Referenced by init.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initWithAddress:port:

- (id) initWithAddress:		(NSString *)	address
port:		(uint16_t)	port

Definition at line 109 of file OODebugTCPConsoleClient.m.

                      :(NSString *)address port:(uint16_t)port
{
    BOOL                    OK = NO;
    NSDictionary            *parameters = nil;
    
    if (address == nil)  address = @"127.0.0.1";
    if (port == 0)  port = kOOTCPConsolePort;
    
    self = [super init];
    if (self != nil)
    {
        _host = [NSHost hostWithName:address];
        if (_host != nil)
        {
            [_host retain];
            [NSStream getStreamsToHost:_host
                                  port:port
                           inputStream:&_inStream
                          outputStream:&_outStream];
        }
        
        if (_inStream != nil && _outStream != nil)
        {
            [_inStream retain];
            [_outStream retain];
            [_inStream setDelegate:self];
            [_outStream setDelegate:self];
            [_inStream scheduleInRunLoop:[NSRunLoop currentRunLoop] forMode:NSDefaultRunLoopMode];
            [_outStream scheduleInRunLoop:[NSRunLoop currentRunLoop] forMode:NSDefaultRunLoopMode];
            [_inStream open];
            [_outStream open];
            
            // Need to wait for the streams to reach open status before we can send packets
            // TODO: Might be neater to use the handleEvent callback to flag this.. - Micha 20090425
            NSRunLoop * myRunLoop = [NSRunLoop currentRunLoop];
            NSDate * timeOut = [NSDate dateWithTimeIntervalSinceNow:3]; // Wait up to 3 seconds
            while( _host != nil && ([_inStream streamStatus] < 2 || [_outStream streamStatus] < 2) &&
                    [myRunLoop runMode:NSDefaultRunLoopMode beforeDate:timeOut] )
                ; // Wait
 
            _decoder = OOTCPStreamDecoderCreate(DecoderPacket, DecoderError, NULL, self);
        }
        
        if (_decoder != NULL)
        {
            OK = YES;
            _status = kOOTCPClientStartedConnectionStage1;
            
            
            // Attempt to connect
            parameters = [NSDictionary dictionaryWithObjectsAndKeys:
                            [NSNumber numberWithUnsignedInt:kOOTCPProtocolVersion_1_1_0], kOOTCPProtocolVersion,
                            [[[NSBundle mainBundle] infoDictionary] objectForKey:@"CFBundleVersion"], kOOTCPOoliteVersion,
                            nil];
            [self sendPacket:kOOTCPPacket_RequestConnection
               withParameters:parameters];
            
            if (_status == kOOTCPClientStartedConnectionStage1)  _status = kOOTCPClientStartedConnectionStage2;
            else  OK = NO;  // Connection failed.
        }
        
        if (!OK)
        {
            OOLog(@"debugTCP.connect.failed", @"Failed to connect to debug console at address %@:%i.", address, port);
            [self release];
            self = nil;
        }
    }
    
    return self;
}

References _decoder, _host, _inStream, _outStream, _status, DecoderError(), DecoderPacket(), kOOTCPClientStartedConnectionStage1, kOOTCPClientStartedConnectionStage2, kOOTCPConsolePort, nil, OOLog, OOTCPStreamDecoderCreate(), and sendPacket:withParameters:.

Referenced by init.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readData

- (void) readData

implementation

Provided by category OODebugTCPConsoleClient(OOPrivate).

Definition at line 467 of file OODebugTCPConsoleClient.m.

{
    enum { kBufferSize = 16 << 10 };
    
    uint8_t                         buffer[kBufferSize];
    NSInteger                       length;
    NSData                          *data;
    
    length = [_inStream read:buffer maxLength:kBufferSize];
    while (length > 0)
    {
        data = [NSData dataWithBytesNoCopy:buffer length:length freeWhenDone:NO];
        OOTCPStreamDecoderReceiveData(_decoder, data);
        length = [_inStream read:buffer maxLength:kBufferSize];
    }
}

Referenced by stream:handleEvent:.

Here is the caller graph for this function:

◆ sendBytes:count:

- (BOOL) sendBytes:		(const void *)	bytes
count:		(size_t)	count

implementation

Provided by category OODebugTCPConsoleClient(OOPrivate).

Definition at line 339 of file OODebugTCPConsoleClient.m.

                  :(const void *)bytes count:(size_t)count
{
    if (bytes == NULL || count == 0)  return YES;
    if (!StatusIsSendable(_status) || _outStream == nil)  return NO;
    
    do
    {
        NSInteger written = [_outStream write:bytes maxLength:count];
        if (written < 1)  return NO;
        
        count -= written;
        bytes += written;
    }
    while (count > 0);
    
    return YES;
}

◆ sendDictionary:

- (void) sendDictionary: (NSDictionary *) dictionary

implementation

Provided by category OODebugTCPConsoleClient(OOPrivate).

Definition at line 358 of file OODebugTCPConsoleClient.m.

                       :(NSDictionary *)dictionary
{
    NSData                  *data = nil;
    NSString                *errorDesc = NULL;
    size_t                  count;
    const uint8_t           *bytes = NULL;
    uint32_t                header;
    bool                    sentOK = YES;
    
    if (dictionary == nil || !StatusIsSendable(_status))  return;
    
    data = [NSPropertyListSerialization dataFromPropertyList:dictionary
                                                      format:NSPropertyListXMLFormat_v1_0
                                            errorDescription:&errorDesc];
    
    if (data == nil)
    {
        OOLog(@"debugTCP.conversionFailure", @"Could not convert dictionary to data for transmission to debug console: %@", errorDesc != NULL ? errorDesc : (NSString *)@"unknown error.");
#if OOLITE_RELEASE_PLIST_ERROR_STRINGS
        [errorDesc autorelease];
#endif
        return;
    }
    
    LogSendPacket(dictionary);
    
    count = [data length];
    if (count == 0)  return;
    header = htonl(count);
    
    bytes = [data bytes];
    
    /*  In testing, all bad stream errors were caused by the python console
        rejecting headers. Made the protocol a bit more fault tolerant.
        -- Kaks 2012.03.24
    */
    if (![self sendBytes:&header count:sizeof header])
    {
        OOLog(@"debugTCP.send.warning", @"%@", @"Error sending packet header, retrying.");
        // wait 8 milliseconds, resend the header
        [[NSRunLoop currentRunLoop] runUntilDate:[NSDate dateWithTimeIntervalSinceNow:.008]];
        if (![self sendBytes:&header count:sizeof header])
        {
            //OOLog(@"debugTCP.send.warning", @"Error sending packet header, retrying one more time.");
            // wait 16 milliseconds, try to resend the header one last time!
            [[NSRunLoop currentRunLoop] runUntilDate:[NSDate dateWithTimeIntervalSinceNow:.016]];
            if (![self sendBytes:&header count:sizeof header])
            {
                sentOK = NO;
            }
        }
    }
    
    if(sentOK && ![self sendBytes:bytes count:count])
    {
        OOLog(@"debugTCP.send.warning", @"%@", @"Error sending packet body, retrying.");
        // wait 8 milliseconds, try again.
        [[NSRunLoop currentRunLoop] runUntilDate:[NSDate dateWithTimeIntervalSinceNow:.008]];
        if(![self sendBytes:bytes count:count])
        {
            sentOK = NO;
        }
    }
    
    if (!sentOK)
    {
        OOLog(@"debugTCP.send.error", @"The following packet could not be sent: %@", dictionary);
        if(![[OODebugMonitor sharedDebugMonitor] TCPIgnoresDroppedPackets])
        {
            [self breakConnectionWithBadStream:_outStream];
        }
    }
}

Referenced by OODebugTCPConsoleClient(OOPrivate)::sendPacket:withParameters:, and OODebugTCPConsoleClient(OOPrivate)::sendPacket:withValue:forParameter:.

Here is the caller graph for this function:

◆ sendPacket:withParameters:

- (void) sendPacket:		(NSString *)	packetType
withParameters:		(NSDictionary *)	parameters

implementation

Provided by category OODebugTCPConsoleClient(OOPrivate).

Definition at line 433 of file OODebugTCPConsoleClient.m.

                   :(NSString *)packetType
     withParameters:(NSDictionary *)parameters
{
    NSDictionary        *dict = nil;
    
    if (packetType == nil)  return;
    
    if (parameters != nil)
    {
        dict = [parameters dictionaryByAddingObject:packetType forKey:kOOTCPPacketType];
    }
    else
    {
        dict = [NSDictionary dictionaryWithObjectsAndKeys:packetType, kOOTCPPacketType, nil];
    }
    
    [self sendDictionary:dict];
}

Referenced by debugMonitor:jsConsoleOutput:colorKey:emphasisRange:, debugMonitorClearConsole:, debugMonitorShowConsole:, and initWithAddress:port:.

Here is the caller graph for this function:

◆ sendPacket:withValue:forParameter:

- (void) sendPacket:	(NSString *)	packetType
withValue:	(id)	value
forParameter:	(NSString *)	paramKey

implementation

Provided by category OODebugTCPConsoleClient(OOPrivate).

Definition at line 453 of file OODebugTCPConsoleClient.m.

                   :(NSString *)packetType
          withValue:(id)value
       forParameter:(NSString *)paramKey
{
    if (packetType == nil)  return;
    if (paramKey == nil)  value = nil;
    
    [self sendDictionary:[NSDictionary dictionaryWithObjectsAndKeys:
        packetType, kOOTCPPacketType,
        value, paramKey,
        nil]];
}

Referenced by debugMonitor:noteChangedConfigrationValue:forKey:, debugMonitor:noteConfiguration:, OODebugTCPConsoleClient(OOPrivate)::disconnectFromServerWithMessage:, and OODebugTCPConsoleClient(OOPrivate)::handlePingPacket:.

Here is the caller graph for this function:

◆ stream:handleEvent:

- (void) stream:		(NSStream *)	stream
handleEvent:		(NSStreamEvent)	eventCode

implementation

Definition at line 298 of file OODebugTCPConsoleClient.m.

              :(NSStream *)stream handleEvent:(NSStreamEvent)eventCode
{
    if (_status > kOOTCPClientConnected)  return;
    
    if (stream == _inStream && eventCode == NSStreamEventHasBytesAvailable)
    {
        [self readData];
    }
    else if (eventCode == NSStreamEventErrorOccurred)
    {
        [self breakConnectionWithBadStream:stream];
    }
    else if (eventCode == NSStreamEventErrorOccurred)
    {
        [self breakConnectionWithMessage:[NSString stringWithFormat:
           @"Console closed the connection."]];
    }
}

References _inStream, _status, breakConnectionWithBadStream:, breakConnectionWithMessage:, kOOTCPClientConnected, and readData.

Here is the call graph for this function:

Member Data Documentation

◆ _decoder

- (struct OOTCPStreamDecoder*) _decoder

private

Definition at line 56 of file OODebugTCPConsoleClient.h.

Referenced by dealloc, and initWithAddress:port:.

◆ _host

- (NSHost*) _host

private

Definition at line 51 of file OODebugTCPConsoleClient.h.

Referenced by initWithAddress:port:.

◆ _inStream

- (NSInputStream*) _inStream

private

Definition at line 53 of file OODebugTCPConsoleClient.h.

Referenced by initWithAddress:port:, and stream:handleEvent:.

◆ _monitor

- (OODebugMonitor*) _monitor

private

Definition at line 55 of file OODebugTCPConsoleClient.h.

Referenced by connectDebugMonitor:errorMessage:, dealloc, and disconnectDebugMonitor:message:.

◆ _outStream

- (NSOutputStream*) _outStream

private

Definition at line 52 of file OODebugTCPConsoleClient.h.

Referenced by initWithAddress:port:.

◆ _status

- (OOTCPClientConnectionStatus) _status

private

Definition at line 54 of file OODebugTCPConsoleClient.h.

Referenced by connectDebugMonitor:errorMessage:, dealloc, initWithAddress:port:, and stream:handleEvent:.

The documentation for this class was generated from the following files:

src/Core/Debug/OODebugTCPConsoleClient.h
src/Core/Debug/OODebugTCPConsoleClient.m

Instance Methods

Private Attributes

Detailed Description

Method Documentation

◆ breakConnectionWithBadStream:

◆ breakConnectionWithMessage:

◆ closeConnection

◆ connectDebugMonitor:errorMessage:

◆ dealloc

◆ debugMonitor:jsConsoleOutput:colorKey:emphasisRange:

◆ debugMonitor:noteChangedConfigrationValue:forKey:

◆ debugMonitor:noteConfiguration:

◆ debugMonitorClearConsole:

◆ debugMonitorShowConsole:

◆ disconnectDebugMonitor:message:

◆ disconnectFromServerWithMessage:

◆ dispatchPacket:ofType:

◆ handleApproveConnectionPacket:

◆ handleCloseConnectionPacket:

◆ handleNoteConfigurationChangePacket:

◆ handlePerformCommandPacket:

◆ handlePingPacket:

◆ handlePongPacket:

◆ handleRejectConnectionPacket:

◆ handleRequestConfigurationValuePacket:

◆ init

◆ initWithAddress:port:

◆ readData

◆ sendBytes:count:

◆ sendDictionary:

◆ sendPacket:withParameters:

◆ sendPacket:withValue:forParameter:

◆ stream:handleEvent:

Member Data Documentation

◆ _decoder

◆ _host

◆ _inStream

◆ _monitor

◆ _outStream

◆ _status