Asposecpplib
System::Net::Sockets::NetworkStream Class Reference

Provides the underlying stream of the data for the network access. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument. More...

Inherits System::IO::Stream.

Public Member Functions

bool get_CanRead () const override
 Determines if the stream is readable. More...
 
bool get_CanSeek () const override
 Determines if the stream supports seeking. More...
 
bool get_CanWrite () const override
 Determines if the stream is writable. More...
 
bool get_CanTimeout () const override
 Gets a value that determines whether the current stream can time out. More...
 
int32_t get_ReadTimeout () const override
 Gets a value, in milliseconds, that determines how long the stream will attempt to read before timing out. More...
 
void set_ReadTimeout (int32_t value) override
 Sets a value that determines whether the current stream can time out. More...
 
int32_t get_WriteTimeout () const override
 Gets a value, in milliseconds, that determines how long the stream will attempt to write before timing out. More...
 
void set_WriteTimeout (int32_t value) override
 Sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out. More...
 
bool get_DataAvailable () const
 Returns a value that indicates if the there is available data to read. More...
 
int64_t get_Length () const override
 Returns the length of the stream in bytes. More...
 
int64_t get_Position () const override
 Returns the current position of the stream. More...
 
void set_Position (int64_t value) override
 Sets the stream's position. More...
 
System::SharedPtr< System::Net::Sockets::Socketget_Socket ()
 Gets the underlying Socket. More...
 
 NetworkStream (System::SharedPtr< System::Net::Sockets::Socket > socket)
 Constructs a new instance. More...
 
 NetworkStream (System::SharedPtr< System::Net::Sockets::Socket > socket, System::IO::FileAccess access, bool ownsSocket)
 Constructs a new instance. More...
 
 NetworkStream (System::SharedPtr< System::Net::Sockets::Socket > socket, bool ownsSocket)
 Constructs a new instance. More...
 
int64_t Seek (int64_t offset, IO::SeekOrigin origin) override
 Sets the position of the stream represented by the current object. More...
 
int32_t Read (System::ArrayPtr< uint8_t > buffer, int32_t offset, int32_t size) override
 Reads the specified number of bytes from the stream and writes them to the specified byte array. More...
 
void Write (System::ArrayPtr< uint8_t > buffer, int32_t offset, int32_t size) override
 Writes the specified subrange of bytes from the specified byte array to the stream. More...
 
void Close (int timeout)
 Closes the current instance after the specified time expires. More...
 
virtual ~NetworkStream ()
 Destructs the current instance. More...
 
System::SharedPtr< IAsyncResultBeginRead (System::ArrayPtr< uint8_t > buffer, int32_t offset, int32_t size, AsyncCallback callback, System::SharedPtr< Object > state) override
 Initiates an asynchronous read operation. More...
 
int32_t EndRead (System::SharedPtr< IAsyncResult > asyncResult) override
 Waits until the specified asynchronous read operation completes. More...
 
System::SharedPtr< IAsyncResultBeginWrite (System::ArrayPtr< uint8_t > buffer, int32_t offset, int32_t size, AsyncCallback callback, System::SharedPtr< Object > state) override
 Initiates an asynchronous write operation. More...
 
void EndWrite (System::SharedPtr< IAsyncResult > asyncResult) override
 Ends an asynchronous write operation. Waits until the specified asynchronous write operation completes. More...
 
void Flush () override
 Clears this stream's buffers and writes all buffered data to the underlying storage. More...
 
void SetLength (int64_t value) override
 Sets the length of the stream represented by the current object. More...
 
- Public Member Functions inherited from System::IO::Stream
virtual int ReadByte ()
 Reads a single byte from the stream and returns a 32-bit integer value equivalent to the value of the read byte. More...
 
virtual void WriteByte (uint8_t value)
 Writes the specified unsigned 8-bit integer value to the stream. More...
 
virtual int Read (ArrayPtr< uint8_t > buffer, int offset, int count)=0
 Reads the specified number of bytes from the stream and writes them to the specified byte array. More...
 
virtual void Write (ArrayPtr< uint8_t > buffer, int offset, int count)=0
 Writes the specified subrange of bytes from the specified byte array to the stream. More...
 
virtual void Close ()
 Closes the stream. More...
 
void Dispose () override
 Releases all resources used by the current object and closes the stream. More...
 
virtual System::SharedPtr< System::IAsyncResultBeginRead (System::ArrayPtr< uint8_t > buffer, int offset, int count, System::AsyncCallback callback, System::SharedPtr< System::Object > state)
 Initiates an asynchronous read operation. More...
 
virtual System::SharedPtr< System::IAsyncResultBeginWrite (System::ArrayPtr< uint8_t > buffer, int offset, int count, System::AsyncCallback callback, System::SharedPtr< System::Object > state)
 Initiates an asynchronous write operation. More...
 
virtual int EndRead (System::SharedPtr< System::IAsyncResult > asyncResult)
 Waits until the specified asynchronous read operation completes. More...
 
virtual void EndWrite (System::SharedPtr< System::IAsyncResult > asyncResult)
 Ends an asynchronous write operation. Waits until the specified asynchronous write operation completes. More...
 
void CopyTo (const SharedPtr< Stream > &destination)
 Copies bytes to the specified stream. More...
 
void CopyTo (const SharedPtr< Stream > &destination, int32_t buffer_size)
 Copies bytes to the specified stream, using the specified buffer size. More...
 
virtual void set_ReadTimeout (int timeout)
 Sets a value that determines whether the current stream can time out. More...
 
virtual void set_WriteTimeout (int timeout)
 Sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Additional Inherited Members

- Public Types inherited from System::IO::Stream
typedef SharedPtr< StreamPtr
 An alias for a shared pointer to this class. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
- Static Public Attributes inherited from System::IO::Stream
static const System::SharedPtr< StreamNull
 A stream with no underlying storage. More...
 
- Protected Member Functions inherited from System::IO::Stream
virtual void Dispose (bool disposing)
 Releases all resources used by the current object and closes the stream. More...
 
virtual int32_t ReadImpl (const ArrayPtr< uint8_t > &buffer, int32_t offset, int32_t count)
 Reads the specified number of bytes from the stream and writes them to the specified buffer. More...
 

Detailed Description

Provides the underlying stream of the data for the network access. Objects of this class should only be allocated using System::MakeObject() function. Never create instance of this type on stack or using operator new, as it will result in runtime errors and/or assertion faults. Always wrap this class into System::SmartPtr pointer and use this pointer to pass it to functions as argument.

Constructor & Destructor Documentation

◆ NetworkStream() [1/3]

System::Net::Sockets::NetworkStream::NetworkStream ( System::SharedPtr< System::Net::Sockets::Socket socket)

Constructs a new instance.

Parameters
socketThe socket that is used for sending and receiving data.

◆ NetworkStream() [2/3]

System::Net::Sockets::NetworkStream::NetworkStream ( System::SharedPtr< System::Net::Sockets::Socket socket,
System::IO::FileAccess  access,
bool  ownsSocket 
)

Constructs a new instance.

Parameters
socketThe socket that is used for sending and receiving data.
accessSpecifies the access type given to the instance over the specified socket.
ownsSocketA value that indicates if the current instance takes ownership of the specified socket when the value is true.

◆ NetworkStream() [3/3]

System::Net::Sockets::NetworkStream::NetworkStream ( System::SharedPtr< System::Net::Sockets::Socket socket,
bool  ownsSocket 
)

Constructs a new instance.

Parameters
socketThe socket that is used for sending and receiving data.
ownsSocketA value that indicates if the current instance takes ownership of the specified socket when the value is true.

◆ ~NetworkStream()

virtual System::Net::Sockets::NetworkStream::~NetworkStream ( )
virtual

Destructs the current instance.

Member Function Documentation

◆ BeginRead()

System::SharedPtr<IAsyncResult> System::Net::Sockets::NetworkStream::BeginRead ( System::ArrayPtr< uint8_t >  buffer,
int32_t  offset,
int32_t  size,
AsyncCallback  callback,
System::SharedPtr< Object state 
)
override

Initiates an asynchronous read operation.

Parameters
bufferThe byte array where the read bytes will be written.
offsetThe offset in bytes in the specified array.
sizeThe number of bytes to read.
callbackA callback to be called when the operation completes.
stateUser-provided data used to uniquely identify each asynchronous read operation.
Returns
An IAsyncResult object representing the initiated asynchronous read operation.

◆ BeginWrite()

System::SharedPtr<IAsyncResult> System::Net::Sockets::NetworkStream::BeginWrite ( System::ArrayPtr< uint8_t >  buffer,
int32_t  offset,
int32_t  size,
AsyncCallback  callback,
System::SharedPtr< Object state 
)
override

Initiates an asynchronous write operation.

Parameters
bufferA buffer containing data to be written.
offsetThe offset in bytes in the specified array.
sizeThe number of bytes to write.
callbackA callback to be called when the operation completes.
stateUser-provided data used to uniquely identify each asynchronous write operation.
Returns
An IAsyncResult object representing the initiated asynchronous write operation.

◆ Close()

void System::Net::Sockets::NetworkStream::Close ( int  timeout)

Closes the current instance after the specified time expires.

Parameters
timeoutA number of milliseconds to wait.

◆ EndRead()

int32_t System::Net::Sockets::NetworkStream::EndRead ( System::SharedPtr< IAsyncResult asyncResult)
override

Waits until the specified asynchronous read operation completes.

Parameters
asyncResultAn IAsyncResult object that represents an asynchronous read operation
Returns
The number of bytes read during the read operation represented by asyncResult

◆ EndWrite()

void System::Net::Sockets::NetworkStream::EndWrite ( System::SharedPtr< IAsyncResult asyncResult)
override

Ends an asynchronous write operation. Waits until the specified asynchronous write operation completes.

Parameters
asyncResultAn IAsyncResult object that represents an asynchronous write operation

◆ Flush()

void System::Net::Sockets::NetworkStream::Flush ( )
overridevirtual

Clears this stream's buffers and writes all buffered data to the underlying storage.

Implements System::IO::Stream.

◆ get_CanRead()

bool System::Net::Sockets::NetworkStream::get_CanRead ( ) const
overridevirtual

Determines if the stream is readable.

Returns
True if the stream is readable; otherwise - false

Implements System::IO::Stream.

◆ get_CanSeek()

bool System::Net::Sockets::NetworkStream::get_CanSeek ( ) const
overridevirtual

Determines if the stream supports seeking.

Returns
True if the stream supports seeking; otherwise - false

Implements System::IO::Stream.

◆ get_CanTimeout()

bool System::Net::Sockets::NetworkStream::get_CanTimeout ( ) const
overridevirtual

Gets a value that determines whether the current stream can time out.

Returns
True when the current stream can time out, otherwise - false.

Reimplemented from System::IO::Stream.

◆ get_CanWrite()

bool System::Net::Sockets::NetworkStream::get_CanWrite ( ) const
overridevirtual

Determines if the stream is writable.

Returns
True if the stream is writable; otherwise - false

Implements System::IO::Stream.

◆ get_DataAvailable()

bool System::Net::Sockets::NetworkStream::get_DataAvailable ( ) const

Returns a value that indicates if the there is available data to read.

Returns
A value that indicates if the there is available data to read.

◆ get_Length()

int64_t System::Net::Sockets::NetworkStream::get_Length ( ) const
overridevirtual

Returns the length of the stream in bytes.

Returns
The length of the stream in bytes.

Implements System::IO::Stream.

◆ get_Position()

int64_t System::Net::Sockets::NetworkStream::get_Position ( ) const
overridevirtual

Returns the current position of the stream.

Returns
The current position of the stream.

Implements System::IO::Stream.

◆ get_ReadTimeout()

int32_t System::Net::Sockets::NetworkStream::get_ReadTimeout ( ) const
overridevirtual

Gets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.

Returns
A value in milliseconds that determines how long the stream will attempt to read before timing out.

Reimplemented from System::IO::Stream.

◆ get_Socket()

System::SharedPtr<System::Net::Sockets::Socket> System::Net::Sockets::NetworkStream::get_Socket ( )

Gets the underlying Socket.

Returns
A Socket object that represents the underlying network connection.

◆ get_WriteTimeout()

int32_t System::Net::Sockets::NetworkStream::get_WriteTimeout ( ) const
overridevirtual

Gets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.

Reimplemented from System::IO::Stream.

◆ Read()

int32_t System::Net::Sockets::NetworkStream::Read ( System::ArrayPtr< uint8_t >  buffer,
int32_t  offset,
int32_t  size 
)
override

Reads the specified number of bytes from the stream and writes them to the specified byte array.

Parameters
bufferThe byte array where the read bytes will be written.
offsetThe offset in bytes in the specified array.
sizeThe number of bytes to read.
Returns
The number of read bytes.

◆ Seek()

int64_t System::Net::Sockets::NetworkStream::Seek ( int64_t  offset,
IO::SeekOrigin  origin 
)
overridevirtual

Sets the position of the stream represented by the current object.

Parameters
offsetThe byte offset relative to a position specified by origin
originSpecifies the position from which and the direction toward which the offset is calculated
Returns
The new position of the stream

Implements System::IO::Stream.

◆ set_Position()

void System::Net::Sockets::NetworkStream::set_Position ( int64_t  value)
overridevirtual

Sets the stream's position.

Parameters
valueThe byte offset to set the stream's position to

Implements System::IO::Stream.

◆ set_ReadTimeout()

void System::Net::Sockets::NetworkStream::set_ReadTimeout ( int32_t  value)
override

Sets a value that determines whether the current stream can time out.

◆ set_WriteTimeout()

void System::Net::Sockets::NetworkStream::set_WriteTimeout ( int32_t  value)
override

Sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.

◆ SetLength()

void System::Net::Sockets::NetworkStream::SetLength ( int64_t  value)
overridevirtual

Sets the length of the stream represented by the current object.

Parameters
valueThe length in bytes to set

Implements System::IO::Stream.

◆ Write()

void System::Net::Sockets::NetworkStream::Write ( System::ArrayPtr< uint8_t >  buffer,
int32_t  offset,
int32_t  size 
)
override

Writes the specified subrange of bytes from the specified byte array to the stream.

Parameters
bufferThe array containing the bytes to write.
offsetThe offset in bytes in the specified array.
sizeThe number of elements in the subrange to write.