Source/NetworkConnection.h

   1 /*
   2  * MacGDBp
   3  * Copyright (c) 2007 - 2011, Blue Static <http://www.bluestatic.org>
   4  *
   5  * This program is free software; you can redistribute it and/or modify it under the terms of the GNU
   6  * General Public License as published by the Free Software Foundation; either version 2 of the
   7  * License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without
  10  * even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along with this program; if not,
  14  * write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
  15  */
  16
  17 #import <Cocoa/Cocoa.h>
  18
  19 #ifdef __cplusplus
  20 class NetworkCallbackController;
  21 #else
  22 @class NetworkCallbackController;
  23 #endif
  24
  25 @protocol NetworkConnectionDelegate;
  26 @class LoggingController;
  27
  28 // This class is the lowest level component to the network. It deals with all
  29 // the intricacies of network and stream programming. Almost all the work this
  30 // class does is on a background thread, which is created when the connection is
  31 // asked to connect and shutdown when asked to close.
  32 @interface NetworkConnection : NSObject
  33 {
  34   // The port to connect on.
  35   NSUInteger port_;
  36
  37   // If the connection to the debugger engine is currently active.
  38   BOOL connected_;
  39
  40   // The thread on which network operations are performed. Weak.
  41   NSThread* thread_;
  42
  43   // Reference to the message loop that the socket runs on. Weak.
  44   NSRunLoop* runLoop_;
  45
  46   // Internal class that manages CFNetwork callbacks. Strong.
  47   NetworkCallbackController* callbackController_;
  48
  49   // The read stream that is scheduled on the main run loop. Weak.
  50   CFReadStreamRef readStream_;
  51
  52   // The write stream. Weak.
  53   CFWriteStreamRef writeStream_;
  54
  55   // Run loop source used to quit the thread. Strong.
  56   CFRunLoopSourceRef quitSource_;
  57
  58   // An ever-increasing integer that gives each transaction a unique ID for the
  59   // debugging engine.
  60   NSUInteger transactionID;
  61
  62   // The most recently received transaction ID.
  63   NSUInteger lastReadTransaction_;
  64
  65   // The last transactionID written to the stream.
  66   NSUInteger lastWrittenTransaction_;
  67
  68   // To prevent blocked writing, we enqueue all writes and then wait for the
  69   // write stream to tell us it's ready. We store the pending commands in this
  70   // array. We use this as a queue (FIFO), with index 0 being first.
  71   NSMutableArray* queuedWrites_;
  72
  73   // We send queued writes in multiple places, sometimes off a run loop event.
  74   // Because of this, we need to ensure that only one client is dequeing and
  75   // sending at a time.
  76   NSRecursiveLock* writeQueueLock_;
  77
  78   // Information about the current read loop. We append to |currentPacket_|
  79   // until |currentPacketSize_| has reached |packetSize_|.
  80   NSMutableString* currentPacket_;
  81   NSInteger packetSize_;
  82   NSInteger currentPacketIndex_;
  83
  84   // The delegate. All methods are executed on the main thread.
  85   NSObject<NetworkConnectionDelegate>* delegate_;
  86 }
  87
  88 @property (readonly) NSUInteger port;
  89 @property (readonly) BOOL connected;
  90 @property (assign) id <NetworkConnectionDelegate> delegate;
  91
  92 - (id)initWithPort:(NSUInteger)aPort;
  93
  94 - (void)connect;
  95 - (void)close;
  96
  97 // This sends the given command format to the debugger. This method is thread
  98 // safe and schedules the request on the |runLoop_|.
  99 - (NSNumber*)sendCommandWithFormat:(NSString*)format, ...;
 100
 101 - (NSString*)escapedURIPath:(NSString*)path;
 102 - (NSInteger)transactionIDFromResponse:(NSXMLDocument*)response;
 103 - (NSInteger)transactionIDFromCommand:(NSString*)command;
 104
 105 @end
 106
 107 // Delegate ////////////////////////////////////////////////////////////////////
 108
 109 @protocol NetworkConnectionDelegate <NSObject>
 110
 111 @optional
 112
 113 - (void)connectionDidAccept:(NetworkConnection*)cx;
 114 - (void)connectionDidClose:(NetworkConnection*)cx;
 115
 116 - (void)handleInitialResponse:(NSXMLDocument*)response;
 117
 118 - (void)handleResponse:(NSXMLDocument*)response;
 119
 120 - (void)errorEncountered:(NSString*)error;
 121
 122 @end