See Also

Tcp Class  | Tcp Members  | Overload List

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

Language

Visual Basic

C#

C++

C++/CLI

Show All

disposing
See Also Languages PowerTCP SSL Sockets for .NET

Dispose(Boolean) Method

Dart.PowerTCP.SslSockets Namespace > Tcp Class > Dispose Method : Dispose(Boolean) Method

Releases all resources associated with the object. 

[Visual Basic]
Overloads Protected Overridable Sub Dispose( _
   ByVal disposing As Boolean _
) 
[C#]
protected virtual void Dispose( 
   bool disposing
);
[C++]
protected: virtual void Dispose( 
   bool disposing
) 
[C++/CLI]
protected:
virtual void Dispose( 
   bool disposing
)

Parameters

disposing

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.

Example

The following example demonstrates connecting to an echo port, sending data, receiving data, then closing the connection.

[Visual Basic] 

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#] 


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
   */
}
                

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

Tcp Class  | Tcp Members  | Overload List

Send comments on this topic.

Documentation version 1.1.2.0.

© 2008 Dart Communications.  All rights reserved.