mirror of
https://github.com/gnustep/libs-base.git
synced 2025-04-29 19:41:00 +00:00
376e495dad
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@21245 72102866-910b-0410-8b05-ffd578937521
239 lines
8 KiB
Objective-C
239 lines
8 KiB
Objective-C
/** Interface for NSFileHandle for GNUStep
|
||
Copyright (C) 1997 Free Software Foundation, Inc.
|
||
|
||
Written by: Richard Frith-Macdonald <richard@brainstorm.co.uk>
|
||
Date: 1997
|
||
|
||
This file is part of the GNUstep Base Library.
|
||
|
||
This library is free software; you can redistribute it and/or
|
||
modify it under the terms of the GNU Library 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 Library 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.
|
||
|
||
AutogsdocSource: NSFileHandle.m
|
||
AutogsdocSource: NSPipe.m
|
||
*/
|
||
|
||
#ifndef __NSFileHandle_h_GNUSTEP_BASE_INCLUDE
|
||
#define __NSFileHandle_h_GNUSTEP_BASE_INCLUDE
|
||
|
||
#include <Foundation/NSObject.h>
|
||
#include <Foundation/NSString.h>
|
||
#include <Foundation/NSData.h>
|
||
|
||
@interface NSFileHandle : NSObject
|
||
|
||
// Allocating and Initializing a FileHandle Object
|
||
|
||
+ (id) fileHandleForReadingAtPath: (NSString*)path;
|
||
+ (id) fileHandleForWritingAtPath: (NSString*)path;
|
||
+ (id) fileHandleForUpdatingAtPath: (NSString*)path;
|
||
+ (id) fileHandleWithStandardError;
|
||
+ (id) fileHandleWithStandardInput;
|
||
+ (id) fileHandleWithStandardOutput;
|
||
+ (id) fileHandleWithNullDevice;
|
||
|
||
- (id) initWithFileDescriptor: (int)desc;
|
||
- (id) initWithFileDescriptor: (int)desc closeOnDealloc: (BOOL)flag;
|
||
- (id) initWithNativeHandle: (void*)hdl;
|
||
- (id) initWithNativeHandle: (void*)hdl closeOnDealloc: (BOOL)flag;
|
||
|
||
// Returning file handles
|
||
|
||
- (int) fileDescriptor;
|
||
- (void*) nativeHandle;
|
||
|
||
// Synchronous I/O operations
|
||
|
||
- (NSData*) availableData;
|
||
- (NSData*) readDataToEndOfFile;
|
||
- (NSData*) readDataOfLength: (unsigned int)len;
|
||
- (void) writeData: (NSData*)item;
|
||
|
||
// Asynchronous I/O operations
|
||
|
||
- (void) acceptConnectionInBackgroundAndNotify;
|
||
- (void) acceptConnectionInBackgroundAndNotifyForModes: (NSArray*)modes;
|
||
- (void) readInBackgroundAndNotify;
|
||
- (void) readInBackgroundAndNotifyForModes: (NSArray*)modes;
|
||
- (void) readToEndOfFileInBackgroundAndNotify;
|
||
- (void) readToEndOfFileInBackgroundAndNotifyForModes: (NSArray*)modes;
|
||
- (void) waitForDataInBackgroundAndNotify;
|
||
- (void) waitForDataInBackgroundAndNotifyForModes: (NSArray*)modes;
|
||
|
||
// Seeking within a file
|
||
|
||
- (unsigned long long) offsetInFile;
|
||
- (unsigned long long) seekToEndOfFile;
|
||
- (void) seekToFileOffset: (unsigned long long)pos;
|
||
|
||
// Operations on file
|
||
|
||
- (void) closeFile;
|
||
- (void) synchronizeFile;
|
||
- (void) truncateFileAtOffset: (unsigned long long)pos;
|
||
|
||
@end
|
||
|
||
// Notification names.
|
||
|
||
/**
|
||
* Posted when one of the [NSFileHandle] methods
|
||
* <code>acceptConnectionInBackground...</code> succeeds and has connected to a
|
||
* stream-type socket in another process. The notification's
|
||
* <em>userInfo</em> dictionary will contain the [NSFileHandle] for the near
|
||
* end of the connection (associated to the key
|
||
* '<code>NSFileHandleNotificationFileHandleItem</code>').
|
||
*/
|
||
GS_EXPORT NSString * const NSFileHandleConnectionAcceptedNotification;
|
||
|
||
/**
|
||
* Posted when one of the [NSFileHandle] methods
|
||
* <code>waitForDataInBackground...</code> has been informed that data is
|
||
* available. The receiving [NSFileHandle] is passed in the notification.
|
||
*/
|
||
GS_EXPORT NSString * const NSFileHandleDataAvailableNotification;
|
||
|
||
/**
|
||
* Posted when one of the [NSFileHandle] methods readDataInBackground... has
|
||
* consumed data. The receiving [NSFileHandle] is passed in the
|
||
* notification's <em>userInfo</em> dictionary associated to the key
|
||
* '<code>NSFileHandleNotificationDataItem</code>'.
|
||
*/
|
||
GS_EXPORT NSString * const NSFileHandleReadCompletionNotification;
|
||
|
||
/**
|
||
* Posted when one of the [NSFileHandle] methods
|
||
* <code>readToEndOfFileInBackground...</code> has finished. The receiving
|
||
* [NSFileHandle] is passed in the notification's <em>userInfo</em> dictionary
|
||
* associated to the key '<code>NSFileHandleNotificationDataItem</code>'.
|
||
*/
|
||
GS_EXPORT NSString * const NSFileHandleReadToEndOfFileCompletionNotification;
|
||
|
||
// Keys for accessing userInfo dictionary in notification handlers.
|
||
|
||
/**
|
||
* Dictionary key for [NSFileHandle] notifications used to access an
|
||
* [NSData] object containing received data.
|
||
*/
|
||
GS_EXPORT NSString * const NSFileHandleNotificationDataItem;
|
||
|
||
/**
|
||
* Dictionary key for [NSFileHandle] notifications used to mark the
|
||
* [NSFileHandle] that has established a stream-socket connection.
|
||
*/
|
||
GS_EXPORT NSString * const NSFileHandleNotificationFileHandleItem;
|
||
|
||
/**
|
||
* Dictionary key for [NSFileHandle] notifications postable to certain run
|
||
* loop modes, associated to an NSArray containing the modes allowed.
|
||
*/
|
||
GS_EXPORT NSString * const NSFileHandleNotificationMonitorModes;
|
||
|
||
// Exceptions
|
||
|
||
/**
|
||
* Exception raised when attempts to read from an [NSFileHandle] channel fail.
|
||
*/
|
||
GS_EXPORT NSString * const NSFileHandleOperationException;
|
||
|
||
@interface NSPipe : NSObject
|
||
{
|
||
NSFileHandle* readHandle;
|
||
NSFileHandle* writeHandle;
|
||
}
|
||
+ (id) pipe;
|
||
- (NSFileHandle*) fileHandleForReading;
|
||
- (NSFileHandle*) fileHandleForWriting;
|
||
@end
|
||
|
||
|
||
|
||
#ifndef NO_GNUSTEP
|
||
|
||
// GNUstep class extensions
|
||
|
||
@interface NSFileHandle (GNUstepExtensions)
|
||
+ (id) fileHandleAsServerAtAddress: (NSString*)address
|
||
service: (NSString*)service
|
||
protocol: (NSString*)protocol;
|
||
+ (id) fileHandleAsClientAtAddress: (NSString*)address
|
||
service: (NSString*)service
|
||
protocol: (NSString*)protocol;
|
||
+ (id) fileHandleAsClientInBackgroundAtAddress: (NSString*)address
|
||
service: (NSString*)service
|
||
protocol: (NSString*)protocol;
|
||
+ (id) fileHandleAsClientInBackgroundAtAddress: (NSString*)address
|
||
service: (NSString*)service
|
||
protocol: (NSString*)protocol
|
||
forModes: (NSArray*)modes;
|
||
- (void) readDataInBackgroundAndNotifyLength: (unsigned)len;
|
||
- (void) readDataInBackgroundAndNotifyLength: (unsigned)len
|
||
forModes: (NSArray*)modes;
|
||
- (BOOL) readInProgress;
|
||
- (NSString*) socketAddress;
|
||
- (NSString*) socketLocalAddress;
|
||
- (NSString*) socketLocalService;
|
||
- (NSString*) socketService;
|
||
- (NSString*) socketProtocol;
|
||
- (BOOL) useCompression;
|
||
- (void) writeInBackgroundAndNotify: (NSData*)item forModes: (NSArray*)modes;
|
||
- (void) writeInBackgroundAndNotify: (NSData*)item;
|
||
- (BOOL) writeInProgress;
|
||
@end
|
||
|
||
/**
|
||
* Where OpenSSL is available, you can use the subclass returned by +sslClass
|
||
* to handle SSL connections.
|
||
* The -sslAccept method is used to do SSL handlshake and start an
|
||
* encrypted session on a channel where the connection was initiated
|
||
* from the far end.
|
||
* The -sslConnect method is used to do SSL handlshake and start an
|
||
* encrypted session on a channel where the connection was initiated
|
||
* from the near end..
|
||
* The -sslDisconnect method is used to end the encrypted session.
|
||
* The -sslSetCertificate:privateKey:PEMpasswd: method is used to
|
||
* establish a client certificate before starting an encrypted session.
|
||
*/
|
||
@interface NSFileHandle (GNUstepOpenSSL)
|
||
+ (Class) sslClass;
|
||
- (BOOL) sslAccept;
|
||
- (BOOL) sslConnect;
|
||
- (void) sslDisconnect;
|
||
- (void) sslSetCertificate: (NSString*)certFile
|
||
privateKey: (NSString*)privateKey
|
||
PEMpasswd: (NSString*)PEMpasswd;
|
||
@end
|
||
|
||
// GNUstep Notification names.
|
||
|
||
/**
|
||
* Notification posted when an asynchronous [NSFileHandle] connection
|
||
* attempt (to an FTP, HTTP, or other internet server) has succeeded.
|
||
*/
|
||
GS_EXPORT NSString * const GSFileHandleConnectCompletionNotification;
|
||
|
||
/**
|
||
* Notification posted when an asynchronous [NSFileHandle] write
|
||
* operation (to an FTP, HTTP, or other internet server) has succeeded.
|
||
*/
|
||
GS_EXPORT NSString * const GSFileHandleWriteCompletionNotification;
|
||
|
||
/**
|
||
* Message describing error in asynchronous [NSFileHandle] accept,read,write
|
||
* operation.
|
||
*/
|
||
GS_EXPORT NSString * const GSFileHandleNotificationError;
|
||
#endif
|
||
|
||
#endif /* __NSFileHandle_h_GNUSTEP_BASE_INCLUDE */
|