Public Instance Methods : SstSocketStream
atEnd
"ACTION
Answer true if the receiver has no further data (End-Of-File).
RETURN VALUE
<Boolean>"
Categories
SST-API User
close
"ACTION
Flush any pending send-data and deallocate the underlying socket."
Categories
SST-API User
cr
"ACTION
Store the line delimiter as the next objects on the receiver.
EXCEPTIONS
ExSstNonFatalError : Thrown if an error occurred while writing
to the underlying socket."
Categories
SST-API User
flush
"ACTION
Write all pending send-elements to the socket.
EXCEPTIONS
ExSstNonFatalError : Thrown if an error occurred while writing
to the underlying socket."
Categories
SST-API User
forgivingNextLine
"ACTION
Answer the %forgivingNextLine attribute. See #forgivingNextLine: for a
description of the possible settings.
RETURN VALUE
<Boolean>"
Categories
SST-API User
forgivingNextLine: value
"ACTION
If @value is true then #nextLine will accept any combination of the
characters in %lineDelimiter as an end-of-line delineation, providing
at least one of the characters is found. If false, then the end-of-line
is signified only by a sequence of bytes matching %lineDelimiter.
PARAMETERS
value : <Boolean>"
Categories
SST-API User
isBytes
"ACTION
Answer true if data will be returned as bytes, or false if as characters.
RETURN VALUE
<Boolean>"
Categories
SST-API User
isBytes: value
"ACTION
If @value is true, data will be returned treated as bytes. If true then
data will be returned as characters.
PARAMETERS
value : <Boolean>"
Categories
SST-API User
isEmpty
"ACTION
Answer true if the receiver can access any objects at this particular
time. This is taken to mean that a #next will not block.
RETURN VALUE
<Boolean>"
Categories
SST-API User
lineDelimiter
"ACTION
Answer the receiver's %lineDelimiter.
RETURN VALUE
<String>"
Categories
SST-API User
lineDelimiter: value
"ACTION
Set the receiver's %lineDelimiter to @value.
PARAMETERS
value : <String>"
Categories
SST-API User
next
"ACTION
Return the next element from the socket. Block if there is no data
available. The element returned will be in a form determined by the
%isBytes attribute.
RETURN VALUE
<Byte> | <Character>
EXCEPTIONS
ExSstNonFatalError : Thrown if an error occurred while reading from
the underlying socket or on EOF."
Categories
SST-API User
next: numberOfBytes
"ACTION
Answer the next @numberOfBytes elements, blocking if necessary,
of an appropriate type depending on the %isBytes attribute.
PARAMETERS
numberOfBytes : <Integer>
RETURN VALUE
<ByteArray> | <String>
EXCEPTIONS
ExSstNonFatalError : Thrown if an error occurred while reading from
the underlying socket or on EOF."
Categories
SST-API User
next: number put: value
"ACTION
Append @number copies of @value to the receiver.
PARAMETERS
number : <Integer>
value : <Character> | <Byte>
EXCEPTIONS
ExSstNonFatalError : Thrown if an error occurred while writing on
the underlying socket."
Categories
SST-API User
nextLine
"ACTION
Answer the next line from the receiver, blocking if necessary, consisting
of the elements between the current position and the next %lineDelimiter.
The actual handling of the %lineDelimiter depends on the
%forgivingNextLine attribute; see #forgivingNextLine: for the description.
Answer an empty collection if the receiver is %atEnd. The result will
be of an appropriate type dictated by the %isBytes attribute. The
%lineDelimiter will not be included in the result.
RETURN VALUE
<ByteArray> | <String>
EXCEPTIONS
ExSstNonFatalError : Thrown if an error occurred while reading from
the underlying socket."
Categories
SST-API User
nextPut: value
"ACTION
Append @value to the receiver.
PARAMETERS
value : <Character> | <Byte>
EXCEPTIONS
ExSstNonFatalError : Thrown if an error occurred while writing on
the underlying socket."
Categories
SST-API User
nextPutAll: collection
"ACTION
Append the contents of @collection to the receiver.
PARAMETERS
collection : <ByteArray> | <String>
EXCEPTIONS
ExSstNonFatalError : Thrown if an error occurred while writing on
the underlying socket."
Categories
SST-API User
nextPutAll: collection size: size
"ACTION
Append the first @size elements of @collection to the receiver.
PARAMETERS
collection : <ByteArray> | <String>
size : <Integer>
EXCEPTIONS
ExSstNonFatalError : Thrown if an error occurred while writing on
the underlying socket."
Categories
SST-API User
peek
"ACTION
Answer the next element available, blocking if necessary, but do not
remove it from the receiver.
RETURN VALUE
<Character> | <Byte>
EXCEPTIONS
ExSstNonFatalError : Thrown if an error occurred while reading from
the underlying socket."
Categories
SST-API User
space
"ACTION
Append a space to the receiver.
EXCEPTIONS
ExSstNonFatalError : Thrown if an error occurred while writing
to the underlying socket."
Categories
SST-API User
space: value
"ACTION
Set the value to be sent as a space.
@value may be either a String or Character.
PARAMETERS
value : <String> | <Character>"
Categories
SST-API User
upTo: anObject
"ACTION
Answer the collection of bytes from the receiver starting with the next
accessible object and up to but not including anObject. Set the
position beyond anObject. If anObject is not present, answer to the
end of the receiver. The collection will be of an appropriate type
depending on the %isBytes attribute.
RETURN VALUE
<String> | <ByteArray>
EXCEPTIONS
ExSstNonFatalError : Thrown if an error occurred while reading
to the underlying socket."
Categories
SST-API User
upToAll: collection
"ACTION
Answer the collection of bytes from the receiver starting with the next
accessible object and up to but not including all of the elements of
@collection. Set the position beyond @collection. If collection is
not present, answer to the end. The collection answered will be of
an appropriate type depending on the %isBytes attribute.
RETURN VALUE
<String> | <ByteArray>
EXCEPTIONS
ExSstNonFatalError : Thrown if an error occurred while reading
to the underlying socket."
Categories
SST-API User
upToEnd
"ACTION
Retrieve the remaining bytes from the receiver starting with the next
accessible element. The collection will be of an appropriate type
depending on the %isBytes attribute.
RETURN VALUE
<String> | <ByteArray>
EXCEPTIONS
ExSstNonFatalError : Thrown if an error occurred while reading
to the underlying socket."
Categories
SST-API User
[FIRST] [PREV] [NEXT] [LAST]