err.no Git - sope/blob - sope-core/NGStreams/README

   1 # $Id$
   2
   3 SKYRiX IO Streaming Library
   4 ===========================
   5
   6 Introduction
   7 ============
   8
   9 This library contains Objective-C classes to access files and
  10 network sockets using a java.io like streaming mechanism.
  11 It also abstracts the Unix socket API (that is, we have extensible
  12 classes for socket domains, addresses etc)
  13
  14 TODO
  15 ====
  16
  17 Should we remove serialization ? It's not available with Jaguar
  18 (MacOSX 10.2) anymore. Currently is turned off on Jaguar.
  19
  20 Removed functionality
  21 =====================
  22
  23 Removed in 4.1, available in MOF3:
  24
  25   NGUrl related things
  26
  27 ... idn't make much sense anymore, now that Foundation has NSURL
  28
  29 Defaults:
  30 =========
  31
  32   ProfileByteBufferEnabled = NO;
  33
  34 Protocols
  35 =========
  36
  37   NGSerializer
  38   NGActiveSocket
  39   NGPositionableStream
  40   NGDatagramPacket
  41   NGSocketAddress
  42   NGSocketDomain
  43
  44 Class Hierachy
  45 ==============
  46
  47   NSObject
  48     NGStream < NGStream, NGByteSequenceStream > (serialization) <NGSerializer>
  49       NGFileStream          < NGPositionableStream >
  50       NGDataStream          < NGPositionableStream >
  51       NGTaskStream
  52       NGFilterStream
  53         NGBase64Stream
  54         NGBufferedStream
  55         NGByteBuffer
  56         NGByteCountStream
  57         NGLockingStream
  58     NGSocket                < NGSocket >
  59       NGActiveSocket        < NGActiveSocket > (serialization) < NGSerializer >
  60       NGPassiveSocket       < NGPassiveSocket >
  61       NGDatagramSocket
  62     NGTextStream            < NGExtendedTextStream >
  63       NGStringTextStream
  64       NGCTextStream
  65       NGFilterTextStream
  66         NGCharBuffer
  67     NGDatagramPacket        < NGDatagramPacket >
  68     NGInternetSocketAddress < NSCopying, NSCoding, NGSocketAddress >
  69     NGInternetSocketDomain  < NSCoding, NSCopying, NGSocketDomain >
  70     NGLocalSocketAddress    < NSCopying, NGSocketAddress >
  71     NGLocalSocketDomain     < NSCopying, NSCoding, NGSocketDomain >
  72     NSFileHandle
  73       NGConcreteStreamFileHandle
  74     NSCoder
  75       NGStreamCoder         < NSObjCTypeSerializationCallBack >
  76     NSPipe
  77       NGStreamPipe          < NGStream, NGByteSequenceStream >
  78
  79 Exceptions
  80 ==========
  81
  82   NSException
  83     NGIOException
  84       NGStreamException
  85         NGEndOfStreamException
  86           NGSocketShutdownException
  87             NGSocketShutdownDuringReadException
  88             NGSocketShutdownDuringWriteException
  89             NGSocketTimedOutException
  90             NGSocketConnectionResetException
  91         NGCouldNotOpenStreamException
  92         NGCouldNotCloseStreamException
  93         NGStreamNotOpenException
  94         NGStreamErrorException
  95           NGStreamReadErrorException
  96           NGStreamWriteErrorException
  97           NGStreamSeekErrorException
  98         NGStreamModeException
  99           NGUnknownStreamModeException
 100           NGReadOnlyStreamException
 101           NGWriteOnlyStreamException
 102       NGIOAccessException
 103         NGIOSearchAccessException
 104       NGSocketException
 105         NGCouldNotResolveHostNameException
 106         NGDidNotFindServiceException
 107         NGInvalidSocketDomainException
 108         NGCouldNotCreateSocketException
 109         NGSocketBindException
 110           NGSocketAlreadyBoundException
 111           NGCouldNotBindSocketException
 112         NGSocketConnectException
 113           NGSocketNotConnectedException
 114           NGSocketAlreadyConnectedException
 115           NGCouldNotConnectException
 116         NGSocketIsAlreadyListeningException
 117         NGCouldNotListenException
 118         NGCouldNotAcceptException
 119         NGSocketOptionException
 120           NGCouldNotSetSocketOptionException
 121           NGCouldNotGetSocketOptionException