Contains the methods for passing credentials across a stream. 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...

#include <authentificated_stream.h>

Inherits System::IO::Stream.

Inherited by System::Net::Security::SslStream.

Public Member Functions
bool	get_LeaveInnerStreamOpen () const
	Returns the stream that is used by the current class instances for sending and receiving data. More...

virtual bool	get_IsAuthenticated () const =0
	Returns a value that indicates if authentication is successfully passed. More...

virtual bool	get_IsMutuallyAuthenticated () const =0
	Returns a value that indicates if a server and a client are authenticated. More...

virtual bool	get_IsEncrypted () const =0
	Returns a value that indicates if the data sent using this stream is encrypted. More...

virtual bool	get_IsSigned () const =0
	Returns a value that indicates if the data sent using this stream is signed. More...

virtual bool	get_IsServer () const =0
	Returns a value that indicates if the local side of the connection is the server. 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 int32_t	Read (const ArrayPtr< uint8_t > &buffer, int32_t offset, int32_t count)=0
	Reads the specified number of bytes from the stream and writes them to the specified byte array. More...

virtual RTaskPtr< int32_t >	ReadAsync (const ArrayPtr< uint8_t > &buffer, int32_t offset, int32_t count, const Threading::CancellationToken &cancellationToken)
	Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests. More...

RTaskPtr< int32_t >	ReadAsync (const ArrayPtr< uint8_t > &buffer, int32_t offset, int32_t count)
	Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests. More...

virtual void	Write (const ArrayPtr< uint8_t > &buffer, int32_t offset, int32_t count)=0
	Writes the specified subrange of bytes from the specified byte array to the stream. More...

virtual TaskPtr	WriteAsync (const ArrayPtr< uint8_t > &buffer, int32_t offset, int32_t count, const Threading::CancellationToken &cancellationToken)
	Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests. More...

TaskPtr	WriteAsync (const ArrayPtr< uint8_t > &buffer, int32_t offset, int32_t count)
	Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests. More...

virtual int32_t	Read (const System::Details::ArrayView< uint8_t > &buffer, int32_t offset, int32_t count)
	Reads the specified number of bytes from the stream and writes them to the specified byte array. More...

virtual void	Write (const System::Details::ArrayView< uint8_t > &buffer, int32_t offset, int32_t count)
	Writes the specified subrange of bytes from the specified byte array to the stream. More...

template<std::size_t N>
int32_t	Read (const System::Details::StackArray< uint8_t, N > &buffer, int32_t offset, int32_t count)
	Reads the specified number of bytes from the stream and writes them to the specified byte array. More...

template<std::size_t N>
void	Write (const System::Details::StackArray< uint8_t, N > &buffer, int32_t offset, int32_t count)
	Writes the specified subrange of bytes from the specified byte array to the stream. More...

virtual int64_t	Seek (int64_t offset, SeekOrigin origin)=0
	Sets the position of the stream represented by the current object. More...

virtual void	SetLength (int64_t value)=0
	Sets the length of the stream represented by the current object. More...

virtual void	Flush ()=0
	Clears this stream's buffers and writes all buffered data to the underlying storage. More...

virtual TaskPtr	FlushAsync (const Threading::CancellationToken &cancellationToken)
	Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests. More...

TaskPtr	FlushAsync ()
	Asynchronously clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests. 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::IAsyncResult >	BeginRead (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::IAsyncResult >	BeginWrite (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_Position (int64_t value)=0
	Sets the stream's position. More...

virtual int64_t	get_Position () const =0
	Returns the current position of the stream. More...

virtual int64_t	get_Length () const =0
	Returns the length of the stream in bytes. More...

virtual bool	get_CanRead () const =0
	Determines if the stream is readable. More...

virtual bool	get_CanSeek () const =0
	Determines if the stream supports seeking. More...

virtual bool	get_CanWrite () const =0
	Determines if the stream is writable. More...

virtual bool	get_CanTimeout () const
	Gets a value that determines whether the current stream can time out. More...

virtual void	set_ReadTimeout (int timeout)
	Sets a value that determines whether the current stream can time out. More...

virtual int	get_ReadTimeout () const
	Gets a value, in milliseconds, that determines how long the stream will attempt to read before timing 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...

virtual int	get_WriteTimeout () const
	Gets a value, in milliseconds, that determines how long the stream will attempt to write before timing out. More...

virtual void	Dispose ()
	Does nothing. 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...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	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 TypeInfo &	GetType () 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...

Protected Member Functions
	AuthenticatedStream (System::SharedPtr< IO::Stream > innerStream, bool leaveInnerStreamOpen)
	Constructs a new instance. More...

System::SharedPtr< IO::Stream >	get_InnerStream () const
	Returns the stream that is used for sending and receiving data. 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...

Additional Inherited Members
Public Types inherited from System::IO::Stream
typedef SharedPtr< Stream >	Ptr
	An alias for a shared pointer to this class. More...

Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	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 TypeInfo &	Type ()
	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< Stream >	Null
	A stream with no underlying storage. More...

Detailed Description

Contains the methods for passing credentials across a stream. 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

◆ AuthenticatedStream()

System::Net::Security::AuthenticatedStream::AuthenticatedStream	(	System::SharedPtr< IO::Stream >	innerStream,
		bool	leaveInnerStreamOpen
	)

protected

Constructs a new instance.

Parameters

innerStream	The stream that is used for sending and receiving data.
leaveInnerStreamOpen	If true, closing the current instance has no effect on 'InnerStream'.

Member Function Documentation

◆ get_InnerStream()

System::SharedPtr< IO::Stream > System::Net::Security::AuthenticatedStream::get_InnerStream ( ) const

protected

Returns the stream that is used for sending and receiving data.

Returns: The stream that is used for sending and receiving data.

◆ get_IsAuthenticated()

virtual bool System::Net::Security::AuthenticatedStream::get_IsAuthenticated ( ) const

pure virtual

Returns a value that indicates if authentication is successfully passed.

Returns: A value that indicates if authentication is successfully passed.

Implemented in System::Net::Security::SslStream.

◆ get_IsEncrypted()

virtual bool System::Net::Security::AuthenticatedStream::get_IsEncrypted ( ) const

pure virtual

Returns a value that indicates if the data sent using this stream is encrypted.

Returns: A value that indicates if the data sent using this stream is encrypted.

Implemented in System::Net::Security::SslStream.

◆ get_IsMutuallyAuthenticated()

virtual bool System::Net::Security::AuthenticatedStream::get_IsMutuallyAuthenticated ( ) const

pure virtual

Returns a value that indicates if a server and a client are authenticated.

Returns: A value that indicates if a server and a client are authenticated.

Implemented in System::Net::Security::SslStream.

◆ get_IsServer()

virtual bool System::Net::Security::AuthenticatedStream::get_IsServer ( ) const

pure virtual

Returns a value that indicates if the local side of the connection is the server.

Returns: A value that indicates if the local side of the connection is the server.

Implemented in System::Net::Security::SslStream.

◆ get_IsSigned()

virtual bool System::Net::Security::AuthenticatedStream::get_IsSigned ( ) const

pure virtual

Returns a value that indicates if the data sent using this stream is signed.

Returns: A value that indicates if the data sent using this stream is signed.

Implemented in System::Net::Security::SslStream.

◆ get_LeaveInnerStreamOpen()

bool System::Net::Security::AuthenticatedStream::get_LeaveInnerStreamOpen ( ) const

Returns the stream that is used by the current class instances for sending and receiving data.

Returns: The stream that is used by the current class instances for sending and receiving data.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AuthenticatedStream()

Member Function Documentation

◆ get_InnerStream()

◆ get_IsAuthenticated()

◆ get_IsEncrypted()

◆ get_IsMutuallyAuthenticated()

◆ get_IsServer()

◆ get_IsSigned()

◆ get_LeaveInnerStreamOpen()