NetworkStream

Overview

Stream wrapper around the Socket class.

Location

  • Reference: Island.fx
  • Namespace: RemObjects.Elements.System
  • Platforms: Android, iOS, iOS Simulator, macOS, tvOS, tvOS Simulator, Ubuntu, UIKit for Mac, watchOS Simulator, watchOS-arm64_32, watchOS-armv7k, Windows
  • Ancestry: Stream | NetworkStream

 

constructor    (declared in Object)

Default constructor.

 

constructor

 

NetworkStream()

 

init()

 

NetworkStream()

 

Sub New()

constructor (Socket)

Creates a new stream for a given socket.

 

constructor(aSocket: Socket)

 

NetworkStream(Socket aSocket)

 

init(_ aSocket: Socket)

 

NetworkStream(Socket aSocket)

 

Sub New(aSocket As Socket)

Parameters:

  • aSocket:

CanRead  override virtual

Should return true if this stream can be read from.

 

property CanRead: Boolean read;

 

Boolean CanRead { get; }

 

var CanRead: Boolean { get{} }

 

Boolean CanRead { __get; }

 

ReadOnly Property CanRead() As Boolean

CanSeek  override virtual

Should return true if this stream can be seeked.

 

property CanSeek: Boolean read;

 

Boolean CanSeek { get; }

 

var CanSeek: Boolean { get{} }

 

Boolean CanSeek { __get; }

 

ReadOnly Property CanSeek() As Boolean

CanWrite  override virtual

Should return true if this stream can be written to.

 

property CanWrite: Boolean read;

 

Boolean CanWrite { get; }

 

var CanWrite: Boolean { get{} }

 

Boolean CanWrite { __get; }

 

ReadOnly Property CanWrite() As Boolean

Close  override virtual

Close this network stream.

 

method Close

 

void Close()

 

func Close()

 

void Close()

 

Sub Close()

CopyTo    (declared in Stream)

Copy the stream to another stream.

 

method CopyTo(Destination: Stream)

 

void CopyTo(Stream Destination)

 

func CopyTo(_ Destination: Stream)

 

void CopyTo(Stream Destination)

 

Sub CopyTo(Destination As Stream)

Parameters:

  • Destination:

Dispose    (declared in Stream)

 

method Dispose

 

void Dispose()

 

func Dispose()

 

void Dispose()

 

Sub Dispose()

Equals  virtual    (declared in Object)

Returns true if the target object matches this one, by default compares the reference.

 

method Equals(obj: Object): Boolean

 

Boolean Equals(Object obj)

 

func Equals(_ obj: Object) -> Boolean

 

Boolean Equals(Object obj)

 

Function Equals(obj As Object) As Boolean

Parameters:

  • obj: the reference to compare this with.

Finalize  protected virtual    (declared in Object)

Finalizer implementation. If not overriden it's not called at all, the runtime checks if there is an override before calling a finalizer.

 

method Finalize

 

void Finalize()

 

func Finalize()

 

void Finalize()

 

Sub Finalize()

Flush  override virtual

Flush this stream (or do nothing if not applicable).

 

method Flush

 

void Flush()

 

func Flush()

 

void Flush()

 

Sub Flush()

GetHashCode  virtual    (declared in Object)

Returns a hashcode for this object. Overriden implementations should make sure that the number returned here is constant given the same object.

 

method GetHashCode: Int32

 

Int32 GetHashCode()

 

func GetHashCode() -> Int32

 

Int32 GetHashCode()

 

Function GetHashCode() As Int32

GetType    (declared in Object)

Returns the actual type of this class

 

method GetType: Type

 

Type GetType()

 

func GetType() -> Type

 

Type GetType()

 

Function GetType() As Type

IsValid  override virtual

Returns true if this stream is still valid.

 

method IsValid: Boolean

 

Boolean IsValid()

 

func IsValid() -> Boolean

 

Boolean IsValid()

 

Function IsValid() As Boolean

Length  virtual    (declared in Stream)

Length of this stream.

 

property Length: Int64 read;

 

Int64 Length { get; }

 

var Length: Int64 { get{} }

 

Int64 Length { __get; }

 

ReadOnly Property Length() As Int64

Position  virtual    (declared in Stream)

Position in this stream.

 

property Position: Int64 read write;

 

Int64 Position { get; set; }

 

var Position: Int64 { get{} set{} }

 

Int64 Position { __get; __set; }

 

Property Position() As Int64

Read (^void, Int32): Int32    (declared in Stream)

Read from stream into buf.

 

method Read(buf: ^void; Count: Int32): Int32

 

Int32 Read(void* buf, Int32 Count)

 

func Read(_ buf: UnsafeMutablePointer<void>, _ Count: Int32) -> Int32

 

Int32 Read(void* buf, Int32 Count)

 

Function Read(buf As ^void, Count As Int32) As Int32

Parameters:

  • buf:
  • Count:

Read (array of Byte, Int32, Int32): Int32    (declared in Stream)

Read from stream into buffer.

 

method Read(Buffer: array of Byte; Offset: Int32; Count: Int32): Int32

 

Int32 Read(Byte[] Buffer, Int32 Offset, Int32 Count)

 

func Read(_ Buffer: Byte..., _ Offset: Int32, _ Count: Int32) -> Int32

 

Int32 Read(Byte[] Buffer, Int32 Offset, Int32 Count)

 

Function Read(Buffer As Byte(), Offset As Int32, Count As Int32) As Int32

Parameters:

  • Buffer:
  • Offset:
  • Count:

Read (Span<Byte>): Int32  override virtual

Read from stream into a span.

 

method Read(aSpan: Span<Byte>): Int32

 

Int32 Read(Span<Byte> aSpan)

 

func Read(_ aSpan: Span<Byte>) -> Int32

 

Int32 Read(Span<Byte> aSpan)

 

Function Read(aSpan As Span<Byte>) As Int32

Parameters:

  • aSpan:

ReferenceEquals    (declared in Object)

Compares two references for equivalence (even if they have an equals operator)

 

class method ReferenceEquals(a: Object; b: Object): Boolean

 

static Boolean ReferenceEquals(Object a, Object b)

 

static func ReferenceEquals(_ a: Object, _ b: Object) -> Boolean

 

static Boolean ReferenceEquals(Object a, Object b)

 

Shared Function ReferenceEquals(a As Object, b As Object) As Boolean

Parameters:

  • a: left value
  • b: right value

Seek  override virtual

Seeks this stream.

 

method Seek(Offset: Int64; Origin: SeekOrigin): Int64

 

Int64 Seek(Int64 Offset, SeekOrigin Origin)

 

func Seek(_ Offset: Int64, _ Origin: SeekOrigin) -> Int64

 

Int64 Seek(Int64 Offset, SeekOrigin Origin)

 

Function Seek(Offset As Int64, Origin As SeekOrigin) As Int64

Parameters:

  • Offset:
  • Origin:

SetLength  virtual    (declared in Stream)

Changes the length of this stream (if applicable).

 

method SetLength(value: Int64)

 

void SetLength(Int64 value)

 

func SetLength(_ value: Int64)

 

void SetLength(Int64 value)

 

Sub SetLength(value As Int64)

Parameters:

  • value:

ToString  virtual    (declared in Object)

Gets the string representation of this method.

 

method ToString: String

 

String ToString()

 

func ToString() -> String

 

String ToString()

 

Function ToString() As String

Write (^void, Int32): Int32    (declared in Stream)

Writes buf to a stream.

 

method Write(buf: ^void; Count: Int32): Int32

 

Int32 Write(void* buf, Int32 Count)

 

func Write(_ buf: UnsafeMutablePointer<void>, _ Count: Int32) -> Int32

 

Int32 Write(void* buf, Int32 Count)

 

Function Write(buf As ^void, Count As Int32) As Int32

Parameters:

  • buf:
  • Count:

Write (array of Byte, Int32, Int32): Int32    (declared in Stream)

Writes a byte array to this stream.

 

method Write(Buffer: array of Byte; Offset: Int32; Count: Int32): Int32

 

Int32 Write(Byte[] Buffer, Int32 Offset, Int32 Count)

 

func Write(_ Buffer: Byte..., _ Offset: Int32, _ Count: Int32) -> Int32

 

Int32 Write(Byte[] Buffer, Int32 Offset, Int32 Count)

 

Function Write(Buffer As Byte(), Offset As Int32, Count As Int32) As Int32

Parameters:

  • Buffer:
  • Offset:
  • Count:

Write (ImmutableSpan<Byte>): Int32  override virtual

Writes a span to this stream.

 

method Write(aSpan: ImmutableSpan<Byte>): Int32

 

Int32 Write(ImmutableSpan<Byte> aSpan)

 

func Write(_ aSpan: ImmutableSpan<Byte>) -> Int32

 

Int32 Write(ImmutableSpan<Byte> aSpan)

 

Function Write(aSpan As ImmutableSpan<Byte>) As Int32

Parameters:

  • aSpan:

 

CanRead  override virtual

Should return true if this stream can be read from.

 

property CanRead: Boolean read;

 

Boolean CanRead { get; }

 

var CanRead: Boolean { get{} }

 

Boolean CanRead { __get; }

 

ReadOnly Property CanRead() As Boolean

CanSeek  override virtual

Should return true if this stream can be seeked.

 

property CanSeek: Boolean read;

 

Boolean CanSeek { get; }

 

var CanSeek: Boolean { get{} }

 

Boolean CanSeek { __get; }

 

ReadOnly Property CanSeek() As Boolean

CanWrite  override virtual

Should return true if this stream can be written to.

 

property CanWrite: Boolean read;

 

Boolean CanWrite { get; }

 

var CanWrite: Boolean { get{} }

 

Boolean CanWrite { __get; }

 

ReadOnly Property CanWrite() As Boolean

Length  virtual    (declared in Stream)

Length of this stream.

 

property Length: Int64 read;

 

Int64 Length { get; }

 

var Length: Int64 { get{} }

 

Int64 Length { __get; }

 

ReadOnly Property Length() As Int64

Position  virtual    (declared in Stream)

Position in this stream.

 

property Position: Int64 read write;

 

Int64 Position { get; set; }

 

var Position: Int64 { get{} set{} }

 

Int64 Position { __get; __set; }

 

Property Position() As Int64

 

ReferenceEquals    (declared in Object)

Compares two references for equivalence (even if they have an equals operator)

 

class method ReferenceEquals(a: Object; b: Object): Boolean

 

static Boolean ReferenceEquals(Object a, Object b)

 

static func ReferenceEquals(_ a: Object, _ b: Object) -> Boolean

 

static Boolean ReferenceEquals(Object a, Object b)

 

Shared Function ReferenceEquals(a As Object, b As Object) As Boolean

Parameters:

  • a: left value
  • b: right value

 

constructor    (declared in Object)

Default constructor.

 

constructor

 

NetworkStream()

 

init()

 

NetworkStream()

 

Sub New()

constructor (Socket)

Creates a new stream for a given socket.

 

constructor(aSocket: Socket)

 

NetworkStream(Socket aSocket)

 

init(_ aSocket: Socket)

 

NetworkStream(Socket aSocket)

 

Sub New(aSocket As Socket)

Parameters:

  • aSocket:

Close  override virtual

Close this network stream.

 

method Close

 

void Close()

 

func Close()

 

void Close()

 

Sub Close()

CopyTo    (declared in Stream)

Copy the stream to another stream.

 

method CopyTo(Destination: Stream)

 

void CopyTo(Stream Destination)

 

func CopyTo(_ Destination: Stream)

 

void CopyTo(Stream Destination)

 

Sub CopyTo(Destination As Stream)

Parameters:

  • Destination:

Dispose    (declared in Stream)

 

method Dispose

 

void Dispose()

 

func Dispose()

 

void Dispose()

 

Sub Dispose()

Equals  virtual    (declared in Object)

Returns true if the target object matches this one, by default compares the reference.

 

method Equals(obj: Object): Boolean

 

Boolean Equals(Object obj)

 

func Equals(_ obj: Object) -> Boolean

 

Boolean Equals(Object obj)

 

Function Equals(obj As Object) As Boolean

Parameters:

  • obj: the reference to compare this with.

Finalize  protected virtual    (declared in Object)

Finalizer implementation. If not overriden it's not called at all, the runtime checks if there is an override before calling a finalizer.

 

method Finalize

 

void Finalize()

 

func Finalize()

 

void Finalize()

 

Sub Finalize()

Flush  override virtual

Flush this stream (or do nothing if not applicable).

 

method Flush

 

void Flush()

 

func Flush()

 

void Flush()

 

Sub Flush()

GetHashCode  virtual    (declared in Object)

Returns a hashcode for this object. Overriden implementations should make sure that the number returned here is constant given the same object.

 

method GetHashCode: Int32

 

Int32 GetHashCode()

 

func GetHashCode() -> Int32

 

Int32 GetHashCode()

 

Function GetHashCode() As Int32

GetType    (declared in Object)

Returns the actual type of this class

 

method GetType: Type

 

Type GetType()

 

func GetType() -> Type

 

Type GetType()

 

Function GetType() As Type

IsValid  override virtual

Returns true if this stream is still valid.

 

method IsValid: Boolean

 

Boolean IsValid()

 

func IsValid() -> Boolean

 

Boolean IsValid()

 

Function IsValid() As Boolean

Read (^void, Int32): Int32    (declared in Stream)

Read from stream into buf.

 

method Read(buf: ^void; Count: Int32): Int32

 

Int32 Read(void* buf, Int32 Count)

 

func Read(_ buf: UnsafeMutablePointer<void>, _ Count: Int32) -> Int32

 

Int32 Read(void* buf, Int32 Count)

 

Function Read(buf As ^void, Count As Int32) As Int32

Parameters:

  • buf:
  • Count:

Read (array of Byte, Int32, Int32): Int32    (declared in Stream)

Read from stream into buffer.

 

method Read(Buffer: array of Byte; Offset: Int32; Count: Int32): Int32

 

Int32 Read(Byte[] Buffer, Int32 Offset, Int32 Count)

 

func Read(_ Buffer: Byte..., _ Offset: Int32, _ Count: Int32) -> Int32

 

Int32 Read(Byte[] Buffer, Int32 Offset, Int32 Count)

 

Function Read(Buffer As Byte(), Offset As Int32, Count As Int32) As Int32

Parameters:

  • Buffer:
  • Offset:
  • Count:

Read (Span<Byte>): Int32  override virtual

Read from stream into a span.

 

method Read(aSpan: Span<Byte>): Int32

 

Int32 Read(Span<Byte> aSpan)

 

func Read(_ aSpan: Span<Byte>) -> Int32

 

Int32 Read(Span<Byte> aSpan)

 

Function Read(aSpan As Span<Byte>) As Int32

Parameters:

  • aSpan:

Seek  override virtual

Seeks this stream.

 

method Seek(Offset: Int64; Origin: SeekOrigin): Int64

 

Int64 Seek(Int64 Offset, SeekOrigin Origin)

 

func Seek(_ Offset: Int64, _ Origin: SeekOrigin) -> Int64

 

Int64 Seek(Int64 Offset, SeekOrigin Origin)

 

Function Seek(Offset As Int64, Origin As SeekOrigin) As Int64

Parameters:

  • Offset:
  • Origin:

SetLength  virtual    (declared in Stream)

Changes the length of this stream (if applicable).

 

method SetLength(value: Int64)

 

void SetLength(Int64 value)

 

func SetLength(_ value: Int64)

 

void SetLength(Int64 value)

 

Sub SetLength(value As Int64)

Parameters:

  • value:

ToString  virtual    (declared in Object)

Gets the string representation of this method.

 

method ToString: String

 

String ToString()

 

func ToString() -> String

 

String ToString()

 

Function ToString() As String

Write (^void, Int32): Int32    (declared in Stream)

Writes buf to a stream.

 

method Write(buf: ^void; Count: Int32): Int32

 

Int32 Write(void* buf, Int32 Count)

 

func Write(_ buf: UnsafeMutablePointer<void>, _ Count: Int32) -> Int32

 

Int32 Write(void* buf, Int32 Count)

 

Function Write(buf As ^void, Count As Int32) As Int32

Parameters:

  • buf:
  • Count:

Write (array of Byte, Int32, Int32): Int32    (declared in Stream)

Writes a byte array to this stream.

 

method Write(Buffer: array of Byte; Offset: Int32; Count: Int32): Int32

 

Int32 Write(Byte[] Buffer, Int32 Offset, Int32 Count)

 

func Write(_ Buffer: Byte..., _ Offset: Int32, _ Count: Int32) -> Int32

 

Int32 Write(Byte[] Buffer, Int32 Offset, Int32 Count)

 

Function Write(Buffer As Byte(), Offset As Int32, Count As Int32) As Int32

Parameters:

  • Buffer:
  • Offset:
  • Count:

Write (ImmutableSpan<Byte>): Int32  override virtual

Writes a span to this stream.

 

method Write(aSpan: ImmutableSpan<Byte>): Int32

 

Int32 Write(ImmutableSpan<Byte> aSpan)

 

func Write(_ aSpan: ImmutableSpan<Byte>) -> Int32

 

Int32 Write(ImmutableSpan<Byte> aSpan)

 

Function Write(aSpan As ImmutableSpan<Byte>) As Int32

Parameters:

  • aSpan: