Asposecpplib
System::Net::Security::SslStream Class Reference

A stream that uses the SSL protocol to authenticate the server and optionally the client. More...

Inherits System::Net::Security::AuthenticatedStream.

Public Types

typedef TlsStreamAsyncResult AsyncResultType
 Type of AsyncResultType. More...
 
typedef std::shared_ptr< System::Net::Details::TlsStreamImplSocket > StreamImplementationPtr
 Type of pointer to the implementation. More...
 
- 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...
 

Public Member Functions

bool get_IsAuthenticated () const override
 Returns a value that indicates if authentication is successfully passed. More...
 
bool get_IsMutuallyAuthenticated () const override
 Returns a value that indicates if a server and a client are authenticated. More...
 
bool get_IsEncrypted () const override
 Returns a value that indicates if the data sent using this stream is encrypted. More...
 
bool get_IsSigned () const override
 Returns a value that indicates if the data sent using this stream is signed. More...
 
bool get_IsServer () const override
 Returns a value that indicates if the local side of the connection is the server. More...
 
virtual System::Security::Authentication::SslProtocols get_SslProtocol ()
 Returns the SSL protocol. More...
 
virtual bool get_CheckCertRevocationStatus ()
 Returns a value that indicates if the certificate revocation list is checked during the certificate validation process. More...
 
virtual System::SharedPtr< System::Security::Cryptography::X509Certificates::X509Certificateget_LocalCertificate ()
 Returns the certificate that is used to authenticate the local endpoint. More...
 
virtual System::SharedPtr< System::Security::Cryptography::X509Certificates::X509Certificateget_RemoteCertificate ()
 Returns the certificate that is used to authenticate the remote endpoint. More...
 
virtual System::Security::Authentication::CipherAlgorithmType get_CipherAlgorithm ()
 Returns the encryption algorithm. More...
 
virtual int32_t get_CipherStrength ()
 Returns the strength of the used encryption algorithm. More...
 
virtual System::Security::Authentication::HashAlgorithmType get_HashAlgorithm ()
 Returns the hash algorithm. More...
 
virtual int32_t get_HashStrength ()
 Returns the strength of the used hash algorithm. More...
 
virtual int32_t get_KeyExchangeStrength ()
 Returns the strength of the used key exchange algorithm. More...
 
bool get_CanSeek () const override
 Determines if the stream supports seeking. More...
 
bool get_CanRead () const override
 Determines if the stream is readable. More...
 
bool get_CanTimeout () const override
 Gets a value that determines whether the current stream can time out. More...
 
bool get_CanWrite () const override
 Determines if the stream is writable. 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...
 
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...
 
 SslStream (System::SharedPtr< IO::Stream > innerStream)
 Constructs a new instance. More...
 
 SslStream (System::SharedPtr< IO::Stream > innerStream, bool leaveInnerStreamOpen)
 Constructs a new instance. More...
 
 SslStream (System::SharedPtr< IO::Stream > innerStream, bool leaveInnerStreamOpen, RemoteCertificateValidationCallback userCertificateValidationCallback)
 Constructs a new instance. More...
 
 SslStream (System::SharedPtr< IO::Stream > innerStream, bool leaveInnerStreamOpen, RemoteCertificateValidationCallback userCertificateValidationCallback, LocalCertificateSelectionCallback userCertificateSelectionCallback)
 Constructs a new instance. More...
 
 SslStream (System::SharedPtr< IO::Stream > innerStream, bool leaveInnerStreamOpen, RemoteCertificateValidationCallback userCertificateValidationCallback, LocalCertificateSelectionCallback userCertificateSelectionCallback, EncryptionPolicy encryptionPolicy)
 Constructs a new instance. More...
 
virtual void AuthenticateAsClient (String targetHost)
 Authenticates the client-side of the connection. More...
 
virtual void AuthenticateAsClient (String targetHost, System::SharedPtr< System::Security::Cryptography::X509Certificates::X509CertificateCollection > clientCertificates, System::Security::Authentication::SslProtocols enabledSslProtocols, bool checkCertificateRevocation)
 Authenticates the client-side of the connection. More...
 
void SetLength (int64_t value) override
 Sets the length of the stream represented by the current object. More...
 
int64_t Seek (int64_t offset, IO::SeekOrigin origin) override
 Sets the position of the stream represented by the current object. More...
 
void Flush () override
 Clears this stream's buffers and writes all buffered data to the underlying storage. More...
 
int32_t Read (System::ArrayPtr< uint8_t > buffer, int32_t offset, int32_t count) 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)
 Writes the specified byte array to the stream. More...
 
void Write (System::ArrayPtr< uint8_t > buffer, int32_t offset, int32_t count) override
 Writes the specified subrange of bytes from the specified byte array to the stream. More...
 
System::SharedPtr< IAsyncResultBeginRead (System::ArrayPtr< uint8_t > buffer, int32_t offset, int32_t count, AsyncCallback asyncCallback, System::SharedPtr< Object > asyncState) 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 count, AsyncCallback asyncCallback, System::SharedPtr< Object > asyncState) 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 Dispose (bool disposing) override
 Releases all resources used by the current object and closes the stream. More...
 
void Close () override
 Closes the stream. More...
 
- Public Member Functions inherited from System::Net::Security::AuthenticatedStream
bool get_LeaveInnerStreamOpen () const
 Returns the stream that is used by the current class instances for sending and receiving data. 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...
 
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

- 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::Net::Security::AuthenticatedStream
 AuthenticatedStream (System::SharedPtr< IO::Stream > innerStream, bool leaveInnerStreamOpen)
 Constructs a new instance. More...
 
System::SharedPtr< IO::Streamget_InnerStream () const
 Returns the stream that is used for sending and receiving data. More...
 
- Protected Member Functions inherited from System::IO::Stream
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

A stream that uses the SSL protocol to authenticate the server and optionally the client.

Member Typedef Documentation

◆ AsyncResultType

◆ StreamImplementationPtr

typedef std::shared_ptr<System::Net::Details::TlsStreamImplSocket> System::Net::Security::SslStream::StreamImplementationPtr

Type of pointer to the implementation.

Constructor & Destructor Documentation

◆ SslStream() [1/5]

System::Net::Security::SslStream::SslStream ( System::SharedPtr< IO::Stream innerStream)

Constructs a new instance.

Parameters
innerStreamThe stream that is used for sending and receiving data.

◆ SslStream() [2/5]

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

Constructs a new instance.

Parameters
innerStreamThe stream that is used for sending and receiving data.
leaveInnerStreamOpenIf true, closing the current instance has no effect on 'InnerStream'.

◆ SslStream() [3/5]

System::Net::Security::SslStream::SslStream ( System::SharedPtr< IO::Stream innerStream,
bool  leaveInnerStreamOpen,
RemoteCertificateValidationCallback  userCertificateValidationCallback 
)

Constructs a new instance.

Parameters
innerStreamThe stream that is used for sending and receiving data.
leaveInnerStreamOpenIf true, closing the current instance has no effect on 'InnerStream'.
userCertificateValidationCallbackThe delegate that is used for validating the certificate supplied by the remote party.

◆ SslStream() [4/5]

System::Net::Security::SslStream::SslStream ( System::SharedPtr< IO::Stream innerStream,
bool  leaveInnerStreamOpen,
RemoteCertificateValidationCallback  userCertificateValidationCallback,
LocalCertificateSelectionCallback  userCertificateSelectionCallback 
)

Constructs a new instance.

Parameters
innerStreamThe stream that is used for sending and receiving data.
leaveInnerStreamOpenIf true, closing the current instance has no effect on 'InnerStream'.
userCertificateValidationCallbackThe delegate that is used for validating the certificate supplied by the remote party.
userCertificateSelectionCallbackThe delegate that is used for selecting the certificate used for authentication.

◆ SslStream() [5/5]

System::Net::Security::SslStream::SslStream ( System::SharedPtr< IO::Stream innerStream,
bool  leaveInnerStreamOpen,
RemoteCertificateValidationCallback  userCertificateValidationCallback,
LocalCertificateSelectionCallback  userCertificateSelectionCallback,
EncryptionPolicy  encryptionPolicy 
)

Constructs a new instance.

Parameters
innerStreamThe stream that is used for sending and receiving data.
leaveInnerStreamOpenIf true, closing the current instance has no effect on 'InnerStream'.
userCertificateValidationCallbackThe delegate that is used for validating the certificate supplied by the remote party.
userCertificateSelectionCallbackThe delegate that is used for selecting the certificate used for authentication.
encryptionPolicyThe encryption policy.

Member Function Documentation

◆ AuthenticateAsClient() [1/2]

virtual void System::Net::Security::SslStream::AuthenticateAsClient ( String  targetHost)
virtual

Authenticates the client-side of the connection.

Parameters
targetHostThe name of the server that shares the current instance.

◆ AuthenticateAsClient() [2/2]

virtual void System::Net::Security::SslStream::AuthenticateAsClient ( String  targetHost,
System::SharedPtr< System::Security::Cryptography::X509Certificates::X509CertificateCollection clientCertificates,
System::Security::Authentication::SslProtocols  enabledSslProtocols,
bool  checkCertificateRevocation 
)
virtual

Authenticates the client-side of the connection.

Parameters
targetHostThe name of the server that shares the current instance.
clientCertificatesThe client certificates.
enabledSslProtocolsThe SSL protocols that are used for authentication.
checkCertificateRevocationA value that indicates if the certificate revocation list must be checked during authentication.

◆ BeginRead()

System::SharedPtr<IAsyncResult> System::Net::Security::SslStream::BeginRead ( System::ArrayPtr< uint8_t >  buffer,
int32_t  offset,
int32_t  count,
AsyncCallback  asyncCallback,
System::SharedPtr< Object asyncState 
)
override

Initiates an asynchronous read operation.

Parameters
bufferThe byte array to read data from.
offsetThe offset in bytes in the specified array.
countThe number of bytes to read.
asyncCallbackA callback to be called when the operation completes.
asyncStateUser-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::Security::SslStream::BeginWrite ( System::ArrayPtr< uint8_t >  buffer,
int32_t  offset,
int32_t  count,
AsyncCallback  asyncCallback,
System::SharedPtr< Object asyncState 
)
override

Initiates an asynchronous write operation.

Parameters
bufferThe byte array to write data to.
offsetThe offset in bytes in the specified array.
countThe number of bytes to write.
asyncCallbackA callback to be called when the operation completes.
asyncStateUser-provided data used to uniquely identify each asynchronous write operation.
Returns
An IAsyncResult object representing the initiated asynchronous write operation.

◆ Close()

void System::Net::Security::SslStream::Close ( )
overridevirtual

Closes the stream.

Reimplemented from System::IO::Stream.

◆ Dispose()

void System::Net::Security::SslStream::Dispose ( bool  disposing)
overridevirtual

Releases all resources used by the current object and closes the stream.

Reimplemented from System::IO::Stream.

◆ EndRead()

int32_t System::Net::Security::SslStream::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::Security::SslStream::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::Security::SslStream::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::Security::SslStream::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::Security::SslStream::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::Security::SslStream::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::Security::SslStream::get_CanWrite ( ) const
overridevirtual

Determines if the stream is writable.

Returns
True if the stream is writable; otherwise - false

Implements System::IO::Stream.

◆ get_CheckCertRevocationStatus()

virtual bool System::Net::Security::SslStream::get_CheckCertRevocationStatus ( )
virtual

Returns a value that indicates if the certificate revocation list is checked during the certificate validation process.

Returns
A value that indicates if the certificate revocation list is checked during the certificate validation

◆ get_CipherAlgorithm()

virtual System::Security::Authentication::CipherAlgorithmType System::Net::Security::SslStream::get_CipherAlgorithm ( )
virtual

Returns the encryption algorithm.

Returns
The encryption algorithm.

◆ get_CipherStrength()

virtual int32_t System::Net::Security::SslStream::get_CipherStrength ( )
virtual

Returns the strength of the used encryption algorithm.

Returns
The strength of the used encryption algorithm.

◆ get_HashAlgorithm()

virtual System::Security::Authentication::HashAlgorithmType System::Net::Security::SslStream::get_HashAlgorithm ( )
virtual

Returns the hash algorithm.

Returns
The hash algorithm.

◆ get_HashStrength()

virtual int32_t System::Net::Security::SslStream::get_HashStrength ( )
virtual

Returns the strength of the used hash algorithm.

Returns
The strength of the used hash algorithm.

◆ get_IsAuthenticated()

bool System::Net::Security::SslStream::get_IsAuthenticated ( ) const
overridevirtual

Returns a value that indicates if authentication is successfully passed.

Returns
A value that indicates if authentication is successfully passed.

Implements System::Net::Security::AuthenticatedStream.

◆ get_IsEncrypted()

bool System::Net::Security::SslStream::get_IsEncrypted ( ) const
overridevirtual

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.

Implements System::Net::Security::AuthenticatedStream.

◆ get_IsMutuallyAuthenticated()

bool System::Net::Security::SslStream::get_IsMutuallyAuthenticated ( ) const
overridevirtual

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.

Implements System::Net::Security::AuthenticatedStream.

◆ get_IsServer()

bool System::Net::Security::SslStream::get_IsServer ( ) const
overridevirtual

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.

Implements System::Net::Security::AuthenticatedStream.

◆ get_IsSigned()

bool System::Net::Security::SslStream::get_IsSigned ( ) const
overridevirtual

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.

Implements System::Net::Security::AuthenticatedStream.

◆ get_KeyExchangeStrength()

virtual int32_t System::Net::Security::SslStream::get_KeyExchangeStrength ( )
virtual

Returns the strength of the used key exchange algorithm.

Returns
The strength of the used key exchange algorithm.

◆ get_Length()

int64_t System::Net::Security::SslStream::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_LocalCertificate()

virtual System::SharedPtr<System::Security::Cryptography::X509Certificates::X509Certificate> System::Net::Security::SslStream::get_LocalCertificate ( )
virtual

Returns the certificate that is used to authenticate the local endpoint.

Returns
The certificate that is used to authenticate the local endpoint.

◆ get_Position()

int64_t System::Net::Security::SslStream::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::Security::SslStream::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_RemoteCertificate()

virtual System::SharedPtr<System::Security::Cryptography::X509Certificates::X509Certificate> System::Net::Security::SslStream::get_RemoteCertificate ( )
virtual

Returns the certificate that is used to authenticate the remote endpoint.

Returns
The certificate that is used to authenticate the remote endpoint.

◆ get_SslProtocol()

virtual System::Security::Authentication::SslProtocols System::Net::Security::SslStream::get_SslProtocol ( )
virtual

Returns the SSL protocol.

Returns
The SSL protocol.

◆ get_WriteTimeout()

int32_t System::Net::Security::SslStream::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::Security::SslStream::Read ( System::ArrayPtr< uint8_t >  buffer,
int32_t  offset,
int32_t  count 
)
override

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

Parameters
bufferThe byte array to write the read bytes to
offsetA 0-based position in buffer to start writing at
countThe number of bytes to read
Returns
The number of bytes read

◆ Seek()

int64_t System::Net::Security::SslStream::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::Security::SslStream::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::Security::SslStream::set_ReadTimeout ( int32_t  value)
override

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

◆ set_WriteTimeout()

void System::Net::Security::SslStream::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::Security::SslStream::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() [1/2]

void System::Net::Security::SslStream::Write ( System::ArrayPtr< uint8_t >  buffer)

Writes the specified byte array to the stream.

Parameters
bufferThe byte array to write.

◆ Write() [2/2]

void System::Net::Security::SslStream::Write ( System::ArrayPtr< uint8_t >  buffer,
int32_t  offset,
int32_t  count 
)
override

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

Parameters
bufferThe array containing the bytes to write
offsetA 0-based index of the element in buffer at which the subrange to write begins
countThe number of elements in the subrange to write