This whole thing could use a rewrite but whatever
[ITFoundation.git] / ITInetSocket.h
index 2f25958..592cc5d 100755 (executable)
  * @abstract Definitions for the ITInetSocket class
  */
 
-/*!
- * @constant ITInetMaxConnections
- * @abstract The maximum number of running ITInetSockets you can have.
- * @discussion The socket will error during a connection request if you are over the maximum.
- */
-
-enum {
-    ITInetMaxConnections = 128
-};
 
 /*!
  * @enum ITInetSocketState
@@ -63,14 +54,7 @@ typedef enum {
  * @abstract Delegate methods for ITInetSocket
  * @discussion ITInetSockets use these methods to communicate with their delegates
  */
-@protocol ITInetSocketDelegate
-/*!
- * @method dataRecieved:
- * @abstract Alerts the delegate of data.
- * @discussion The delegate should check [sender readPipe] to get the data.
- * @param sender The socket that the messages came from.
- */
-- (void) dataRecieved:(ITInetSocket *)sender;
+@protocol ITInetSocketDelegate <DataReciever>
 /*!
  * @method errorOccured:during:onSocket:
  * @abstract Alerts the delegate of an error condition.
@@ -79,14 +63,14 @@ typedef enum {
  * @param state What the socket was doing when the error occured.
  * @param sender The socket the error occured on.
  */
-- (void) errorOccured:(ITInetSocketError)err during:(ITInetSocketState)state onSocket:(ITInetSocket*)sender;
+- (oneway void) errorOccured:(ITInetSocketError)err during:(ITInetSocketState)state onSocket:(ITInetSocket*)sender;
 /*!
  * @method finishedConnecting:
  * @abstract Alerts the delegate of a successful connection attempt.
  * @discussion The delegate should send whatever initial data is required for the protocol (nickname for IRC, etc.)
  * @param sender The socket that established the connection.
  */
-- (void) finishedConnecting:(ITInetSocket *)sender;
+- (oneway void) finishedConnecting:(ITInetSocket *)sender;
 @end
 
 /*!
@@ -94,25 +78,52 @@ typedef enum {
  * @abstract An Internet socket class.
  * @discussion ITInetSocket is an Internet socket class supporting IPv6 and Rendezvous.
  */
-@interface ITInetSocket : NSObject {
-    @public
+@interface ITInetSocket : NSObject <DataReciever> {
     int sockfd;
     int port;
-    id delegate;
+    int nc;
+    unsigned short bufs;
+    volatile int dieflag;
+    volatile int actionflag;
+    id <ITInetSocketDelegate> delegate;
     struct addrinfo *ai, *ai_cur;
     ITByteStream *readPipe, *writePipe;
     ITInetSocketState state;
     NSArray *sarr;
 }
+/*!
+ * @method startAutoconnectingToService:delegate:
+ * @abstract Automatically creates sockets whenever a certain type of Rendezvous service appears.
+ * @discussion The auto-created sockets will send finishedConnecting: to the delegate.
+ * @param type The type of Rendezvous service to listen on.
+ * @param d The delegate that the sockets will belong to.
+ */
 +(void)startAutoconnectingToService:(NSString*)type delegate:(id <ITInetSocketDelegate>)d;
+/*!
+ * @method initWithFD:delegate:
+ * @abstract Wraps a socket around an existing socket descriptor.
+ * @discussion The socket will start listening on the descriptor as normal.
+ * @param fd The descriptor.
+ * @param d The delegate for the socket.
+ */
 -(id) initWithFD:(int)fd delegate:(id <ITInetSocketDelegate>)d;
+/*!
+ * @method initWithDelegate:
+ * @abstract Creates a new socket.
+ * @discussion The socket will not be connected to anything.
+ * @param d The delegate of the socket.
+ */
 -(id) initWithDelegate:(id <ITInetSocketDelegate>)d;
 
 -(id <ITInetSocketDelegate>)delegate;
+-(unsigned short)bufferSize;
+-(void)setBufferSize:(unsigned short)bufs;
 -(void) connectToHost:(NSString*)host onPort:(short)port;
 -(void) connectToHost:(NSString*)host onNamedPort:(NSString*)port;
 -(void) connectWithSockaddrArray:(NSArray*)arr;
 -(ITInetSocketState) state;
 -(void) retryConnection;
 -(void) disconnect;
+-(ITByteStream *)readPipe;
+-(ITByteStream *)writePipe;
 @end