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

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