Server : Apache/2.4.41 (Ubuntu) System : Linux absol.cf 5.4.0-198-generic #218-Ubuntu SMP Fri Sep 27 20:18:53 UTC 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.33 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, Directory : /usr/GNUstep/Local/Library/Headers/Foundation/
Upload File :
Current File : //usr/GNUstep/Local/Library/Headers/Foundation/NSStream.h
/** Interface for NSStream for GNUStep
Copyright (C) 2006 Free Software Foundation, Inc.
Written by: Derek Zhou <derekzhou@gmail.com>
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
Lesser 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 02110 USA.
*/
#ifndef __NSStream_h_GNUSTEP_BASE_INCLUDE
#define __NSStream_h_GNUSTEP_BASE_INCLUDE
#import <GNUstepBase/GSVersionMacros.h>
#if OS_API_VERSION(MAC_OS_X_VERSION_10_4,GS_API_LATEST) && GS_API_VERSION( 10200,GS_API_LATEST)
#import <Foundation/NSObject.h>
#if defined(__cplusplus)
extern "C" {
#endif
enum {
NSStreamStatusNotOpen = 0,
NSStreamStatusOpening = 1,
NSStreamStatusOpen = 2,
NSStreamStatusReading = 3,
NSStreamStatusWriting = 4,
NSStreamStatusAtEnd = 5,
NSStreamStatusClosed = 6,
NSStreamStatusError = 7
};
typedef NSUInteger NSStreamStatus;
enum {
NSStreamEventNone = 0,
NSStreamEventOpenCompleted = 1,
NSStreamEventHasBytesAvailable = 2,
NSStreamEventHasSpaceAvailable = 4,
NSStreamEventErrorOccurred = 8,
NSStreamEventEndEncountered = 16
};
typedef NSUInteger NSStreamEvent;
@class NSError;
@class NSHost;
@class NSInputStream;
@class NSOutputStream;
@class NSString;
@class NSRunLoop;
@class NSURL;
/**
* NSStream is an abstract class for objects representing streams.
*/
GS_EXPORT_CLASS
@interface NSStream : NSObject
/**
* Creates and returns by reference an NSInputStream object and NSOutputStream
* object for a socket connection with the specified port on host.
*/
+ (void) getStreamsToHost: (NSHost *)host
port: (NSInteger)port
inputStream: (NSInputStream **)inputStream
outputStream: (NSOutputStream **)outputStream;
/**
* Closes the receiver.<br />
* Repeated calls to this method on the same stream are quietly ignored.
*/
- (void) close;
/**
* Returns the receiver's delegate.
*/
- (id) delegate;
/**
* Opens the receiving stream.<br />
* Upon completion of the open operation, an NSStreamEventOpenCompleted
* event is sent to the recevier's delegate.<br />
* Repeated calls to this method on the same stream are quietly ignored.
*/
- (void) open;
/**
* Returns the receiver's property for the specified key.
*/
- (id) propertyForKey: (NSString *)key;
/**
* Removes the receiver from the NSRunLoop specified by aRunLoop
* running in the mode.<br />
* Attempts to remove the receiver from a run loop or a mode in
* which it has not been scheduled are quietly ignored.
*/
- (void) removeFromRunLoop: (NSRunLoop *)aRunLoop forMode: (NSString *)mode;
/**
* Schedules the receiver on aRunLoop using the specified mode.<br />
* You must not attempt to add a stream to more than one run loop,
* but you may call this method multiple times to add the receiver
* in different modes for the same run loop.
*/
- (void) scheduleInRunLoop: (NSRunLoop *)aRunLoop forMode: (NSString *)mode;
/**
* Sets the receiver's delegate.
*/
- (void) setDelegate: (id)delegate;
/**
* Sets the value of the property specified by key to property, returns YES
* if the key-value pair are accepted by the receiver.
*/
- (BOOL) setProperty: (id)property forKey: (NSString *)key;
/**
* Returns an NSError object representing the stream error, or nil if no error
* has been encountered.
*/
- (NSError *) streamError;
/**
* Returns the receiver's status.
*/
- (NSStreamStatus) streamStatus;
@end
@class NSData;
/**
* NSInputStream is a subclass of NSStream that provides read-only
* stream functionality.
*/
GS_EXPORT_CLASS
@interface NSInputStream : NSStream
/**
* Creates and returns an initialized NSInputStream object
* for reading from data.
*/
+ (id) inputStreamWithData: (NSData *)data;
/**
* Creates and returns an initialized NSInputStream object that reads data from
* the file at the specified path.
*/
+ (id) inputStreamWithFileAtPath: (NSString *)path;
/**
* Creates and returns an initialized NSInputStream object that reads data from
* the specified URL.
*/
+ (id) inputStreamWithURL: (NSURL *)url;
/**
* Returns a pointer to the read buffer in buffer and, by reference, the number
* of bytes available in len.
*/
- (BOOL) getBuffer: (uint8_t **)buffer length: (NSUInteger *)len;
/**
* Returns YES if the receiver has bytes available to read.
* The receiver may also return YES if a read must be attempted
* in order to determine the availability of bytes.
*/
- (BOOL) hasBytesAvailable;
/**
* Returns an initialized NSInputStream object for reading from data.
*/
- (id) initWithData: (NSData *)data;
/**
* Returns an initialized NSInputStream object for reading from the file at the
* specified path.
*/
- (id) initWithFileAtPath: (NSString *)path;
/**
* Returns an initialized NSInputStream object for reading from the
* specified URL.
*/
- (id) initWithURL: (NSURL *)url;
/**
* Reads up to len bytes into buffer, returning the actual number of bytes read.
*/
- (NSInteger) read: (uint8_t *)buffer maxLength: (NSUInteger)len;
@end
/**
* NSOutputStream is a subclass of NSStream that provides
* write-only stream functionality.
*/
GS_EXPORT_CLASS
@interface NSOutputStream : NSStream
/**
* Creates and returns an initialized NSOutputStream object
* that can write to buffer, up to a maximum of capacity bytes.
*/
+ (id) outputStreamToBuffer: (uint8_t *)buffer capacity: (NSUInteger)capacity;
/**
* Creates and returns an initialized NSOutputStream object
* for writing to the file specified by path.
*/
+ (id) outputStreamToFileAtPath: (NSString *)path append: (BOOL)shouldAppend;
/**
* Creates and returns an initialized NSOutputStream object
* that will write stream data to memory.
*/
+ (id) outputStreamToMemory;
/**
* Returns YES if the receiver can be written to,
* or if a write must be attempted
* in order to determine if space is available.
*/
- (BOOL) hasSpaceAvailable;
/**
* Returns an initialized NSOutputStream object that can write to buffer,
* up to a maximum of capacity bytes.
*/
- (id) initToBuffer: (uint8_t *)buffer capacity: (NSUInteger)capacity;
/**
* Returns an initialized NSOutputStream object for writing to the file
* specified by path.<br />
* If shouldAppend is YES, newly written data will be appended to any
* existing file contents.
*/
- (id) initToFileAtPath: (NSString *)path append: (BOOL)shouldAppend;
/**
* Returns an initialized NSOutputStream object that will write to memory.
*/
- (id) initToMemory;
/**
* Writes the contents of buffer, up to a maximum of len bytes,
* to the receiver.
*/
- (NSInteger) write: (const uint8_t *)buffer maxLength: (NSUInteger)len;
@end
GS_EXPORT NSString * const NSStreamDataWrittenToMemoryStreamKey;
GS_EXPORT NSString * const NSStreamFileCurrentOffsetKey;
GS_EXPORT NSString * const NSStreamSocketSecurityLevelKey;
GS_EXPORT NSString * const NSStreamSocketSecurityLevelNone;
GS_EXPORT NSString * const NSStreamSocketSecurityLevelSSLv2;
GS_EXPORT NSString * const NSStreamSocketSecurityLevelSSLv3;
GS_EXPORT NSString * const NSStreamSocketSecurityLevelTLSv1;
GS_EXPORT NSString * const NSStreamSocketSecurityLevelNegotiatedSSL;
GS_EXPORT NSString * const NSStreamSocketSSLErrorDomain;
GS_EXPORT NSString * const NSStreamSOCKSErrorDomain;
GS_EXPORT NSString * const NSStreamSOCKSProxyConfigurationKey;
GS_EXPORT NSString * const NSStreamSOCKSProxyHostKey;
GS_EXPORT NSString * const NSStreamSOCKSProxyPasswordKey;
GS_EXPORT NSString * const NSStreamSOCKSProxyPortKey;
GS_EXPORT NSString * const NSStreamSOCKSProxyUserKey;
GS_EXPORT NSString * const NSStreamSOCKSProxyVersion4;
GS_EXPORT NSString * const NSStreamSOCKSProxyVersion5;
GS_EXPORT NSString * const NSStreamSOCKSProxyVersionKey;
#if OS_API_VERSION(MAC_OS_X_VERSION_10_7,GS_API_LATEST) && GS_PROTOCOLS_HAVE_OPTIONAL
@protocol NSStreamDelegate <NSObject>
@optional
- (void) stream: (NSStream*)sStream handleEvent: (NSStreamEvent)anEvent;
@end
#else
/**
* Informal protocol for delegates of instance of the [NSStream] class.
*/
@interface NSObject (NSStreamDelegate)
- (void) stream: (NSStream*)sStream handleEvent: (NSStreamEvent)anEvent;
@end
#endif
#if defined(__cplusplus)
}
#endif
#if !NO_GNUSTEP && !defined(GNUSTEP_BASE_INTERNAL)
#import <GNUstepBase/NSStream+GNUstepBase.h>
#endif
#endif /* 100200 */
#endif /* __NSStream_h_GNUSTEP_BASE_INCLUDE */
Server : Apache/2.4.41 (Ubuntu)