Class: ProtocolClient

• Inheritance
• Description
• Class protocol
  • accessing
  • instance creation
• Instance protocol
  • accessing
  • actions
  • private
  • private protocol
  • private testing
  • testing

Inheritance:

   Object
   |
   +--ProtocolClient

Package:

stx:libcompat

Category:

Network-Protocols

Version:

rev: 1.3 date: 2019/03/13 09:30:28

user: cg

file: ProtocolClient.st directory: libcompat

module: stx stc-classLibrary: libcompat

Description:

ProtocolClient is the abstract super class for a variety of network protocol clients.
It uses a stream rather than the direct network access so it could also work for streams on serial connections etc.

Structure:
	stream				stream representing the connection to and from the server
	connectInfo			information required for opening a connection
	lastResponse			remembers the last response from the server.
	progressObservers 	any object understanding #show: can be registered as a progress observer (login, transfer, etc)

Class protocol:

 defaultPortNumber

 logFlag

 openOnHost: hostIP port: portNumber

 openOnHostNamed: hostName

If the hostname uses the colon syntax to express a certain portnumber
we use that instead of the default port number.

 openOnHostNamed: hostName port: portNumber

Instance protocol:

 logProgressToTranscript

 messageText

 response

 stream

 stream: aStream

 close

 reopen

 connectionInfo

 defaultPortNumber

 ensureConnection

 host

 host: hostId

 lastResponse

 lastResponse: aString

 logFlag

 logProgress: aString

 openOnHost: hostIP port: portNumber

 password

 password: aString

 pendingResponses

 popResponse

 port

 port: aPortNumber

 progressObservers

 pushResponse: aResponse

 resetConnectionInfo

 user

 user: aString

 checkForPendingError

If data is waiting, check it to catch any error reports.
In case the response is not an error, push it back.

 checkResponse

 checkResponse: aResponse onError: errorBlock onWarning: warningBlock

Get the response from the server and check for errors.
Invoke one of the blocks if an error or warning is encountered.
See class comment for classification of error codes.

 checkResponseOnError: errorBlock onWarning: warningBlock

Get the response from the server and check for errors.
Invoke one of the blocks if an error or warning is encountered.
See class comment for classification of error codes.

 fetchNextResponse

 fetchPendingResponse

 sendCommand: aString

 sendStreamContents: aStream

 responseIsError

 responseIsWarning

 isConnected