Instance Methods
(void)	- closeConnection

(BOOL)	- sendBytes:count:

(void)	- sendDictionary:

(void)	- sendPacket:withParameters:

(void)	- sendPacket:withValue:forParameter:

(void)	- readData

(void)	- dispatchPacket:ofType:

(void)	- handleApproveConnectionPacket:

(void)	- handleRejectConnectionPacket:

(void)	- handleCloseConnectionPacket:

(void)	- handleNoteConfigurationChangePacket:

(void)	- handlePerformCommandPacket:

(void)	- handleRequestConfigurationValuePacket:

(void)	- handlePingPacket:

(void)	- handlePongPacket:

(void)	- disconnectFromServerWithMessage:

(void)	- breakConnectionWithMessage:

(void)	- breakConnectionWithBadStream:

Detailed Description

Definition at line 68 of file OODebugTCPConsoleClient.m.

Method Documentation

◆ breakConnectionWithBadStream:

- (void) breakConnectionWithBadStream: (NSStream *) stream

Definition at line 704 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: %llu, inStream status: %llu).",
        errorDesc, [_outStream streamStatus], [_inStream streamStatus]]];
}

◆ breakConnectionWithMessage:

- (void) breakConnectionWithMessage: (NSString *) message

Definition at line 704 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
}

◆ closeConnection

- (void) closeConnection

Definition at line 704 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;
}

◆ disconnectFromServerWithMessage:

- (void) disconnectFromServerWithMessage: (NSString *) message

Definition at line 704 of file OODebugTCPConsoleClient.m.

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

◆ dispatchPacket:ofType:

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

Definition at line 704 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);
    }
}

◆ handleApproveConnectionPacket:

- (void) handleApproveConnectionPacket: (NSDictionary *) packet

Definition at line 704 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

Definition at line 704 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

Definition at line 704 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)
    {
        foreachkey (key, configuration)
        {
            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

Definition at line 704 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

Definition at line 704 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

Definition at line 704 of file OODebugTCPConsoleClient.m.

                         :(NSDictionary *)packet
{
    // Do nothing; we don't currently send pings.
}

◆ handleRejectConnectionPacket:

- (void) handleRejectConnectionPacket: (NSDictionary *) packet

Definition at line 704 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

Definition at line 704 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];
    }
}

◆ readData

- (void) readData

Definition at line 704 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];
    }
}

◆ sendBytes:count:

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

Definition at line 704 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

Definition at line 704 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];
        }
    }
}

◆ sendPacket:withParameters:

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

Definition at line 704 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];
}

◆ sendPacket:withValue:forParameter:

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

Definition at line 704 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]];
}

The documentation for this category was generated from the following file:

src/Core/Debug/OODebugTCPConsoleClient.m

Instance Methods

Detailed Description

Method Documentation

◆ breakConnectionWithBadStream:

◆ breakConnectionWithMessage:

◆ closeConnection

◆ disconnectFromServerWithMessage:

◆ dispatchPacket:ofType:

◆ handleApproveConnectionPacket:

◆ handleCloseConnectionPacket:

◆ handleNoteConfigurationChangePacket:

◆ handlePerformCommandPacket:

◆ handlePingPacket:

◆ handlePongPacket:

◆ handleRejectConnectionPacket:

◆ handleRequestConfigurationValuePacket:

◆ readData

◆ sendBytes:count:

◆ sendDictionary:

◆ sendPacket:withParameters:

◆ sendPacket:withValue:forParameter: