mirror of
https://github.com/gnustep/libs-base.git
synced 2025-04-22 16:33:29 +00:00
f59ba481f0
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@29853 72102866-910b-0410-8b05-ffd578937521
202 lines
5 KiB
Objective-C
202 lines
5 KiB
Objective-C
#ifndef INCLUDED_GSSTREAM_H
|
|
#define INCLUDED_GSSTREAM_H
|
|
|
|
/** Implementation for GSStream for GNUStep
|
|
Copyright (C) 2006 Free Software Foundation, Inc.
|
|
|
|
Written by: Derek Zhou <derekzhou@gmail.com>
|
|
Written by: Richard Frith-Macdonald <rfm@gnu.org>
|
|
Date: 2006
|
|
|
|
This library is free software; you can redistribute it and/or
|
|
modify it under the terms of the GNU Lesser General Public
|
|
License as published by the Free Software Foundation; either
|
|
version 2 of the License, or (at your option) any later version.
|
|
|
|
This library is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
Library General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Lesser General Public
|
|
License along with this library; if not, write to the Free
|
|
Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
|
|
Boston, MA 02111 USA.
|
|
|
|
NSInputStream and NSOutputStream are clusters rather than concrete classes
|
|
The inherance graph is:
|
|
NSStream
|
|
|-- GSStream
|
|
| `--GSSocketStream
|
|
|-- NSInputStream
|
|
| `--GSInputStream
|
|
| |-- GSDataInputStream
|
|
| |-- GSFileInputStream
|
|
| |-- GSPipeInputStream (mswindows only)
|
|
| `-- GSSocketInputStream
|
|
| |-- GSInetInputStream
|
|
| |-- GSLocalInputStream
|
|
| `-- GSInet6InputStream
|
|
|-- NSOutputStream
|
|
| `--GSOutputStream
|
|
| |-- GSBufferOutputStream
|
|
| |-- GSDataOutputStream
|
|
| |-- GSFileOutputStream
|
|
| |-- GSPipeOutputStream (mswindows only)
|
|
| `-- GSSocketOutputStream
|
|
| |-- GSInetOutputStream
|
|
| |-- GSLocalOutputStream
|
|
| `-- GSInet6InputStream
|
|
`-- GSServerStream
|
|
`-- GSAbstractServerStream
|
|
|-- GSLocalServerStream (mswindows)
|
|
`-- GSSocketServerStream
|
|
|-- GSInetServerStream
|
|
|-- GSInet6ServerStream
|
|
`-- GSLocalServerStream (gnu/linux)
|
|
*/
|
|
|
|
#import "Foundation/NSStream.h"
|
|
#import "Foundation/NSRunLoop.h"
|
|
#import "Foundation/NSMapTable.h"
|
|
#import "GNUstepBase/NSStream+GNUstepBase.h"
|
|
|
|
/**
|
|
* Convenience methods used to add streams to the run loop.
|
|
*/
|
|
@interface NSRunLoop (NSStream)
|
|
- (void) addStream: (NSStream*)aStream mode: (NSString*)mode;
|
|
- (void) removeStream: (NSStream*)aStream mode: (NSString*)mode;
|
|
@end
|
|
|
|
@class NSMutableData;
|
|
|
|
#define IVARS \
|
|
{ \
|
|
id _delegate; /* Delegate controls operation. */\
|
|
NSMutableDictionary *_properties; /* storage for properties */\
|
|
BOOL _delegateValid;/* whether the delegate responds*/\
|
|
NSError *_lastError; /* last error occured */\
|
|
NSStreamStatus _currentStatus;/* current status */\
|
|
NSMapTable *_loops; /* Run loops and their modes. */\
|
|
void *_loopID; /* file descriptor etc. */\
|
|
int _events; /* Signalled events. */\
|
|
}
|
|
|
|
/**
|
|
* GSInputStream and GSOutputStream both inherit methods from the
|
|
* GSStream class using 'behaviors', and must therefore share
|
|
* EXACTLY THE SAME initial ivar layout.
|
|
*/
|
|
@interface GSStream : NSStream
|
|
IVARS
|
|
@end
|
|
|
|
@interface GSAbstractServerStream : GSServerStream
|
|
IVARS
|
|
@end
|
|
|
|
@interface NSStream(Private)
|
|
|
|
/**
|
|
* Async notification
|
|
*/
|
|
- (void) _dispatch;
|
|
|
|
/**
|
|
* Return YES if the stream is opened, NO otherwise.
|
|
*/
|
|
- (BOOL) _isOpened;
|
|
|
|
/**
|
|
* Return previously set reference for IO in run loop.
|
|
*/
|
|
- (void*) _loopID;
|
|
|
|
/** Reset events in mask to allow them to be sent again.
|
|
*/
|
|
- (void) _resetEvents: (NSUInteger)mask;
|
|
|
|
/**
|
|
* Place the stream in all the scheduled runloops.
|
|
*/
|
|
- (void) _schedule;
|
|
|
|
/**
|
|
* send an event to delegate
|
|
*/
|
|
- (void) _sendEvent: (NSStreamEvent)event;
|
|
|
|
/**
|
|
* setter for IO event reference (file descriptor, file handle etc )
|
|
*/
|
|
- (void) _setLoopID: (void *)ref;
|
|
|
|
/**
|
|
* set the status to newStatus. an exception is error cannot
|
|
* be overwriten by closed
|
|
*/
|
|
- (void) _setStatus: (NSStreamStatus)newStatus;
|
|
|
|
/**
|
|
* record an error based on errno
|
|
*/
|
|
- (void) _recordError;
|
|
- (void) _recordError: (NSError*)anError;
|
|
|
|
/**
|
|
* say whether there is unhandled data for the stream.
|
|
*/
|
|
- (BOOL) _unhandledData;
|
|
|
|
/**
|
|
* Remove the stream from all the scheduled runloops.
|
|
*/
|
|
- (void) _unschedule;
|
|
|
|
@end
|
|
|
|
@interface GSInputStream : NSInputStream
|
|
IVARS
|
|
@end
|
|
|
|
@interface GSOutputStream : NSOutputStream
|
|
IVARS
|
|
@end
|
|
|
|
/**
|
|
* The concrete subclass of NSInputStream that reads from the memory
|
|
*/
|
|
@interface GSDataInputStream : GSInputStream
|
|
{
|
|
@private
|
|
NSData *_data;
|
|
unsigned long _pointer;
|
|
}
|
|
@end
|
|
|
|
/**
|
|
* The concrete subclass of NSOutputStream that writes to a buffer
|
|
*/
|
|
@interface GSBufferOutputStream : GSOutputStream
|
|
{
|
|
@private
|
|
uint8_t *_buffer;
|
|
unsigned _capacity;
|
|
unsigned long _pointer;
|
|
}
|
|
@end
|
|
|
|
/**
|
|
* The concrete subclass of NSOutputStream that writes to a variable sise buffer
|
|
*/
|
|
@interface GSDataOutputStream : GSOutputStream
|
|
{
|
|
@private
|
|
NSMutableData *_data;
|
|
unsigned long _pointer;
|
|
}
|
|
@end
|
|
|
|
#endif
|
|
|