PowerTCP Mail for .NET
Dispose(Boolean) Method
See Also  Example Send comments on this topic.
Dart.PowerTCP.Mail Namespace > Tcp Class > Dispose Method : Dispose(Boolean) Method




disposing
Releases all resources associated with the object.

Syntax

Visual Basic (Declaration) 
Protected Overloads Overrides Sub Dispose( _
   ByVal disposing As Boolean _
) 
Visual Basic (Usage)Copy Code
Dim instance As Tcp
Dim disposing As Boolean
 
instance.Dispose(disposing)
C# 
protected override void Dispose( 
   bool disposing
)
Managed Extensions for C++ 
protected: void Dispose( 
   bool disposing
) override 
C++/CLI 
protected:
void Dispose( 
   bool disposing
) override 

Parameters

disposing

Example

The following example demonstrates connecting to an echo port, sending data, receiving data, then closing the connection.
Visual BasicCopy Code
Private Sub TcpDemo()

   ' Connect to echo port.
   Tcp1.Connect("atropos", "7")

   ' Send some data
   Dim seg As Segment = Tcp1.Send("Hello")

   ' Display info
   Debug.WriteLine("Bytes of data sent: " & seg.Count)
   Debug.WriteLine("Data sent: " & seg.ToString())

   ' Receive response (this should be the same as the sent data)
   seg = Tcp1.Receive()

   ' Display info
   Debug.WriteLine("Bytes of data received: " & seg.Count)
   Debug.WriteLine("Data received: " & seg.ToString())

   ' Since connection is to an echo port, the client has to
   ' close the connection.
   Try
      Tcp1.Close()
   Catch ex As Exception
      ' Error, just dispose the object.
      Tcp1.Dispose()
   End Try

   '* Output
   '* --------------------------
   '* Bytes of data sent: 5
   '* Data sent: Hello
   '* Bytes of data received: 5
   '* Data received: Hello
   '*
End Sub
C#Copy Code
private void TcpDemo()
{
   // Connect to echo port.
   tcp1.Connect("atropos", "7"); 

   // Send some data
   Segment seg = tcp1.Send("Hello");

   // Display info
   Debug.WriteLine("Bytes of data sent: " + seg.Count);
   Debug.WriteLine("Data sent: " + seg.ToString());

   // Receive response (this should be the same as the sent data)
   seg = tcp1.Receive();

   // Display info
   Debug.WriteLine("Bytes of data received: " + seg.Count);
   Debug.WriteLine("Data received: " + seg.ToString());

   // Since connection is to an echo port, the client has to
   // close the connection.
   try
   {
      tcp1.Close();
   }
   catch(Exception ex)
   {
      // Error, just dispose the object.
      tcp1.Dispose();
   }

   /* Output
    * --------------------------
    * Bytes of data sent: 5
    * Data sent: Hello
    * Bytes of data received: 5
    * Data received: Hello
    */
}

Remarks

The Object.Dispose method abruptly aborts the connection and releases all resources.

Object.Dispose should ONLY be used to release all resources used by the object, and the object should not be used subsequently. If an abort is desired, then Object.Close or Object.Connection.Close if available should be used to terminate activity and reset the object. The Object cannot be used once Object.Dispose or Object.Dispose(true) are called.

Requirements

Target Platforms: Microsoft .NET Framework 2.0

See Also

Documentation Version 3.2
© 2010 Dart Communications. All Rights Reserved.