Dart.PowerTCP.SslSockets Namespace > Tcp Class : Connected Property |
Gets the connected state of the connection.
[Visual Basic]
<DescriptionAttribute("Returns true when an active connection exists.")>
<BrowsableAttribute(False)>
Public ReadOnly Property Connected As Boolean
[C#]
[DescriptionAttribute("Returns true when an active connection exists.")]
[BrowsableAttribute(false)]
public bool Connected {get;}
[C++]
[DescriptionAttribute("Returns true when an active connection exists.")]
[BrowsableAttribute(false)]
public: __property bool get_Connected();
[C++/CLI]
[DescriptionAttribute("Returns true when an active connection exists.")]
[BrowsableAttribute(false)]
public:
property bool Connected {
bool get();
}
true if the TCP connection is connected to a remote resource and authenticated; otherwise, false.
If the PowerTCP component is connected to a remote resource AND authenticated, this property returns true. If this property is false, the connection was either never connected, is no longer connected, or is connected but not yet authenticated. When receiving data from the server, this property is a good way to tell if all data has been received. Keep receiving data in a loop until this property equals false.
When using PowerTCP components which make use of the Tcp component as the underlying connection, this property returns the same value as the Object.Connection.Connected property (where Object.Connection exposes the Tcp object used for the connection).
The Object.ConnectedChanged and Object.ConnectedChangedEx events are raised whenever this property changes.
The following example demonstrates the code required to build a simple echo server.
[Visual Basic]
Private Sub StartServer()
' Begin listening for connections on port 7.
Server1.Listen(7)
End Sub
Private Sub Server1_Connection(ByVal sender As Object, ByVal e As ConnectionEventArgs) Handles Server1.Connection
' This event is raised on a new thread when a connection is received.
Try
' Keep receiving data until connection is closed
Do While (e.Tcp.Connected)
' Receive data.
Dim seg As Segment = e.Tcp.Receive()
' Echo data back to client
e.Tcp.Send(seg.ToString())
Loop
Catch ex As Exception
'eat exception
End Try
End Sub
[C#]
private void StartServer()
{
// Begin listening for connections on port 7.
server1.Listen(7);
}
private void server1_Connection(object
sender, ConnectionEventArgs e)
{
// This event is raised on a new thread when a connection is received.
try
{
// Keep receiving data until connection is closed
while(e.Tcp.Connected)
{
// Receive data.
Segment seg = e.Tcp.Receive();
// Echo data back to client.
e.Tcp.Send(seg.ToString());
}
}
catch(Exception ex)
{
// eat any exceptions
}
}
Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family
Send comments on this topic.
Documentation version 1.1.2.0.
© 2008 Dart Communications. All rights reserved.