 |
 |
PowerTCP SSL Sockets for .NET |
| Dart.PowerTCP.SslSockets Namespace > Tcp Class > Receive Method : Receive() Method |
|
|
PowerTCP SSL Sockets for .NET |
| Dart.PowerTCP.SslSockets Namespace > Tcp Class > Receive Method : Receive() Method |
Receive data from the host.
[Visual Basic]
<DescriptionAttribute("Receives data into a dynamically instantiated buffer before returning it as an ASCII string.")>
Overloads Public Function Receive() As Segment[C#]
[DescriptionAttribute("Receives data into a dynamically instantiated buffer before returning it as an ASCII string.")]
public Segment Receive();[C++]
[DescriptionAttribute("Receives data into a dynamically instantiated buffer before returning it as an ASCII string.")]
public: Segment* Receive(); [C++/CLI]
[DescriptionAttribute("Receives data into a dynamically instantiated buffer before returning it as an ASCII string.")]
public:
Segment^ Receive(); A Segment object encapsulating the data received.
| Exception | Description |
|---|---|
| IOException | The stream is not Readable. |
| ArgumentNullException | buffer is null. |
| ArgumentOutOfRangeException | offset or count is less than 0. |
| ArgumentException | offset + count is greater than the length of buffer. |
| SocketException | The socket is not connected. |
After connecting, data can be received using the Tcp.Recieve method. All Tcp.Receive methods return a Segment object, encapsulating the data received. In order to access the data, simply access the properties of the Segment object returned such as Buffer (to access the data in a byte array) or ToString (to access the data as a string).
If the amount of data received from the server exceeds ReceiveBufferSize, the Tcp.Receive method will have to be called multiple times until the socket closes.
This method is functionally equivalent to Tcp.Stream.Write().
The following example demonstrates blocking operations using the Tcp component.
[Visual Basic]
Private Sub TcpDemo()
' The following code assumes that good responses are always received from
' the server. More robust code should check each response and handle appropriately.
' Connect to Echo Server
Tcp1.Connect("myEchoServer", 7)
' Send some data
Tcp1.Send("Hello Server!" + vbCrLf)
' Get response from the server
Dim seg As Segment = Tcp1.Receive()
Debug.WriteLine(seg.ToString())
' Send more data
Tcp1.Send("You are a swell host" + vbCrLf)
' Get response from the server
seg = Tcp1.Receive()
Debug.WriteLine(seg.ToString())
'Close the connection
Tcp1.Close()
End Sub
[C#]
private void TcpDemo()
{
// The following code assumes that good responses are always received from
// the server. More robust code should check each response and handle appropriately.
// Connect to Echo Server
tcp1.Connect("myEchoServer", 7);
// Send some data
tcp1.Send("Hello Server!\r\n");
// Get response from the server
Segment seg = tcp1.Receive();
Debug.WriteLine(seg.ToString());
// Send more data
tcp1.Send("You are a swell host\r\n");
// Get response from the server
seg = tcp1.Receive();
Debug.WriteLine(seg.ToString());
//Close the connection
tcp1.Close();
}
Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family
Tcp Class | Tcp Members | Overload List
Send comments on this topic.
Documentation version 1.1.2.0.
© 2008 Dart Communications. All rights reserved.