Click or drag to resize

TcpServer Class

A TCP server.
Inheritance Hierarchy
SystemObject
  Demo3D.Net.ProtocolsTcpServer

Namespace:  Demo3D.Net.Protocols
Assembly:  Demo3D.IO (in Demo3D.IO.dll) Version: 10.0.0.0 (10.0.0.0)
Syntax
C#
Copy
public static class TcpServer
Methods
  NameDescription
Public methodStatic memberCode exampleOpen(Int32, NotifyDataChangedEventHandler)
Opens a TCP server. Creates a server and starts accepting connections, calling 'dataChangedHandler' with data from each connection as it arrives. This method returns after the server has been established, leaving the accepting and servicing of connections to a background thread.
Public methodStatic memberCode exampleOpen(Int32, ServiceClientAsyncIPacketIOService)
Opens a TCP server. Creates a server and starts accepting connections, calling 'serviceConnection' with each connection established. This method returns after the server has been established, leaving the accepting and servicing of connections to a background thread.
Public methodStatic memberCode exampleOpenAsync(Int32, NotifyDataChangedEventHandler)
Opens a TCP server. Creates a server and starts accepting connections, calling 'dataChangedHandler' with data from each connection as it arrives. This method returns after the server has been established, leaving the accepting and servicing of connections to a background thread.
Public methodStatic memberCode exampleOpenAsync(Int32, ServiceClientAsyncIPacketIOService)
Opens a TCP server. Creates a server and starts accepting connections, calling 'serviceConnection' with each connection established. This method returns after the server has been established, leaving the accepting and servicing of connections to a background thread.
Top
Remarks
This class is a wrapper around ProtocolServer.Open{IPacketIOService} and ProtocolAddressBuilder. See ProtocolServer and ProtocolAddressBuilder for more advanced usage.
Examples

The following example shows a simple TCP server that accepts connections, waits for data to be received and then calls a method to handle the messages read from the each of the clients.

See TcpClient for the implementation of the client that works with this server.

C#
Copy
using System;
using Demo3D.Native;
using Demo3D.Net;
using Demo3D.Net.Protocols;
using Demo3D.Visuals;

namespace Examples.Net.TcpServerExample {
    [Auto] public class Server {
        [Auto] IBuilder                 app;
        [Auto] Document                 doc;
        [Auto] PrintDelegate            print;
        [Auto] SimplePropertyValue<int> tcpPort;     // The port to run the server on.

        [Auto] void OnInitialize(Visual sender) {
            // Open a server on the configured tcpPort.
            // This variant of TcpServer.Open will open the server, accept incoming connections and
            // wait for data to arrive on each of the connections.  It will then call ReceiveMessage
            // when data is received on any of the clients.
            TcpServer.Open(tcpPort, ReceiveMessage);
        }

        void ReceiveMessage(ProtocolSocket socket, object service, NotifyDataChangedEventArgs e) {
            try {
                var args = (PacketChangedEventArgs)e;  // A TCP server uses PacketChangedEventArgs.
                int message;

                // Read from the packet.
                using (var packet = args.GetPacket()) {
                    // Read the message from the client - in this case a single integer.
                    message = packet.ReadInt32();
                }

                // Handle the message.
                HandleMessage(message);
            }
            catch (Exception x) {
                socket.Close(x);
            }
        }

        void HandleMessage(int message) {
            print("Message received " + message);
        }
    }
}
See Also