Shuts down send and/or receives in preparation for closing the stream.

Namespace:  Quanser.Communications
Assembly:  Quanser.Communications (in Quanser.Communications.dll)

Syntax

Visual Basic (Declaration)
Public Sub Shutdown
C#
public void Shutdown()
Visual C++
public:
void Shutdown()
JavaScript
function shutdown();

Remarks

This method shuts down send and/or receive operations in preparation for closing the stream. It is typically called from another thread in order to interrupt a blocking send or receive operation prior to closing the stream. If an error occurs, then it throws a StreamException. If the connection is closed it is considered an error condition.

Examples

This code snippet shows how to shutdown the stream.
C# Copy Code
stream.Shutdown();
Visual Basic Copy Code
stream.Shutdown()
Visual C++ Copy Code
stream->Shutdown();

Exceptions

ExceptionCondition
Quanser.Communications..::.StreamException If an error occurs then an exception is thrown. This situation typically arises if the stream was closed prior to calling Shutdown()()().

See Also