IRISLIB database
NullStream Class Reference

Read returns nothing, Write does nothing. More...

Inheritance diagram for NullStream:
Collaboration diagram for NullStream:

Public Member Functions

_.Library.Boolean AtEndGet ()
 Read returns nothing, Write does nothing.
 
_.Library.String Read (_.Library.Integer pMaxReadLen, _.Library.Numeric pTimeout, _.Library.Status pSC)
 Read until pMaxReadLen chars are gotten or pTimeout expires. More...
 
 Write (_.Library.String pData, _.Library.Boolean pFlush, _.Library.Status pSC)
 Write pData to the stream buffer. More...
 
- Public Member Functions inherited from Stream
_.Library.Boolean Close (_.Library.Status pSC)
 Close the current stream.
 
_.Library.Integer CopyFrom (_.IO.I.Stream pSource, _.Library.Numeric pTimeout, _.Library.Boolean pFlush, _.Library.Status pSC)
 Copy all available data from pSource to the current stream buffer. More...
 
_.Library.Integer CopyReplace (_.IO.I.Stream pDest, _.Library.Integer pMaxReadLen, _.Library.Numeric pTimeout, _.Library.Numeric pIdleTimeout, _.Library.String pPrevBuf, _.Library.Boolean pFlush, _.Library.Boolean pInsensitive, _.Library.String pRewind, _.Library.Status pSC, pSearchReplace)
 Replace from the current stream the strings contained in a list of alternating search and replace target string arguments. More...
 
_.Library.Integer CopyReplaceArray (_.IO.I.Stream pDest, _.Library.Integer pMaxReadLen, _.Library.Numeric pTimeout, _.Library.Numeric pIdleTimeout, _.Library.String pPrevBuf, _.Library.Boolean pFlush, _.Library.Boolean pInsensitive, _.Library.String pRewind, _.Library.Status pSC, pSearchReplace)
 Replace from the current stream the strings contained in an array of alternating search and replace target string values called pSearchReplace. More...
 
 Flush (_.Library.Status pSC)
 Ensure that any data already written to the stream buffer are actually sent to the stream.
 
_.Library.Integer OutputToDevice (_.Library.Integer pLength, _.Library.Numeric pTimeout, _.Library.Status pSC)
 Copy all available data from the current stream to the current system device.
 
_.Library.String ReadUntil (_.Library.Integer pMaxReadLen, _.Library.Numeric pTimeout, _.Library.Numeric pIdleTimeout, _.Library.String pPrevBuf, _.Library.Boolean pInsensitive, _.Library.Integer pWhich, _.Library.Status pSC, pTarget)
 Read until one of the Target strings is found or a timeout occurs. More...
 
_.Library.String ReadUntilArray (_.Library.Integer pMaxReadLen, _.Library.Numeric pTimeout, _.Library.Numeric pIdleTimeout, _.Library.String pPrevBuf, _.Library.Boolean pInsensitive, _.Library.Integer pWhich, _.Library.Status pSC, pTargets)
 Read until one of the Target strings is found or a timeout occurs. More...
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 

Additional Inherited Members

- Public Attributes inherited from Stream
 AtEnd
   More...
 
 DefaultFlushOnWrite
 InputStream interface. More...
 
 IsCharacter
   More...
 
 IsOpen
   More...
 
 Name
   More...
 
- Public Attributes inherited from ByteIO
 CharEncoding
 Info-only description of the character encoding that this byte stream represents, if it. More...
 
- Public Attributes inherited from SeekableIO
 Position
   More...
 
 Size
   More...
 
- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Detailed Description

Read returns nothing, Write does nothing.

Member Function Documentation

◆ Read()

_.Library.String Read ( _.Library.Integer  pMaxReadLen,
_.Library.Numeric  pTimeout,
_.Library.Status  pSC 
)

Read until pMaxReadLen chars are gotten or pTimeout expires.

On return, if pTimeout is unchanged it means the full timeout period expired. If the timeout period expired and the returned string is shorter than pMaxReadLen, then AtEnd will be 1.

Reimplemented from Stream.

◆ Write()

Write ( _.Library.String  pData,
_.Library.Boolean  pFlush,
_.Library.Status  pSC 
)

Write pData to the stream buffer.

If pFlush is True, ensure that the data are actually sent to the stream.

Reimplemented from Stream.