Class: OSErrorHolder

• Inheritance
• Description
• Class protocol
  • Signal constants
  • class initialization
  • instance creation
• Instance protocol
  • accessing
  • error reporting
  • others
  • printing
  • private
  • testing

Inheritance:

   Object
   |
   +--OSErrorHolder

Package:

stx:libbasic

Category:

OS-Support

Version:

rev: 1.34 date: 2022/12/02 12:09:06

user: stefan

file: OSErrorHolder.st directory: libbasic

module: stx stc-classLibrary: libbasic

Description:

This class represents low level operating system errors.
We do not use error numbers, because there may be different errnos
for the same error on different systems.

[instance variables:]
    errorSymbol             symbol associated with this error
    errorCategory           symbol defining the error category.
                            This is in fact a symbol that returns a
                            Signal when sent to myself.

    While the errorSymbol may be different on different platforms,
    the errorCategories (which refer to the Signals that will be raised)
    are identical.
    You can get an OS independent error message for an error by sending
    #errorCategoryString.

copyright
COPYRIGHT (c) 1997 by eXept Software AG / Claus Gittinger
             All Rights Reserved

This software is furnished under a license and may be used
only in accordance with the terms of that license and with the
inclusion of the above copyright notice.   This software may not
be provided or otherwise made available to, or used by, any
other person.  No title to or ownership of the software is
hereby transferred.

Class protocol:

 allocRetrySignal

 badAccessorSignal

 badArgumentsSignal

 classNotRegisteredSignal

 coNotInitializedSignal

 defaultOsErrorSignal

 errorSignal

(comment from inherited method)
return the signal used for error/error: - handling

 existingReferentSignal

 illegalOperationSignal

 inaccessibleSignal

 inappropriateOperationSignal

 inappropriateReferentSignal

 invalidArgumentsSignal

return the signal for invalid arguments (e.g. right class, wrong value).

 needRetrySignal

 noAggregationSignal

 noAssociationSignal

 noDataSignal

 noInterfaceSignal

 noMemorySignal

 noPermissionsSignal

 noResourcesSignal

 noVerbsSignal

 nonexistentSignal

return the signal for non existing referents (i.e. device, file etc.).

 notReadySignal

 peerFaultSignal

 rangeErrorSignal

 signalNamed: signalName

 signals

 transferFaultSignal

 transientErrorSignal

 unavailableReferentSignal

 underSpecifiedSignal

 unknownNameSignal

 unpreparedOperationSignal

 unsupportedOperationSignal

 volumeFullSignal

 wrongSubtypeForOperationSignal

 initializeSignals

init signals etc.

Usage example(s):

Signals := nil. self initializeSignals.

Usage example(s):

Signals := nil. self initializeSignals

 setupSignal: aSymbol parent: parentSignal notifier: aString

setup a signal, which can be retrieved by sending aSymbol to self.
Return the new signal

 errorNumber: num errorSymbol: sym errorCategory: typ

 errorSymbol: sym errorCategory: typ

 unsupportedOperation

Instance protocol:

 errorCategory

 errorNumber

 errorNumber: num errorSymbol: sym errorCategory: typ

 errorSymbol

 errorSymbol: sym errorCategory: typ

 parameter

 parameter: something

 reportError

Report an error.

Usage example(s):

(OperatingSystem errorHolderForNumber:22) reportError

 reportError: errorMessage

Report an error. Show insert errorMessage into error string.

 reportProceedableError

Report an error.

 reportProceedableError: errorMessage

Report an error. Show insert errorMessage into error string.

 description

 errorString

 printOn: aStream

(comment from inherited method)
append a user printed representation of the receiver to aStream.
The format is suitable for a human - not meant to be read back.

The default here is to output the receiver's class name.
BUT: this method is heavily redefined for objects which
can print prettier.

 makeErrorStringFor: aString

Private: compute an errorString from myself and aString

 isOSErrorHolder