SuperSocket Wiki Rss Feed

Updated Wiki: Home

kerryjiang — Mon, 06 May 2013 03:05:10 GMT

SuperSocket is a light weight, cross platform and extensible socket server application framework. You can use it to build a server side socket application (like GPS server, GIS server, game server, FTP server, SMTP/POP3/IMAP4 server, SIP server, SNMP server, etc) easily without thinking about how to use socket, how to maintain the socket connections and how socket works.

It is a pure C# project which is designed to be extended, so it is easy to be integrated to your existing system. If your systems (like forum/CRM/MIS/HRM/ERP) are developed in .NET language, you must be able to use SuperSocket to build your socket application as a part of your current system perfectly.

The source code of SuperSocket also include some service implementation samples which you can follow.

Latest stable release:

SuperSocket 1.5.2 https://supersocket.codeplex.com/releases/view/104825

Latest beta release:

SuperSocket 1.6 beta 1 https://supersocket.codeplex.com/releases/view/106205

Features:

Very easy to use. You can create a robust socket server only by several classes
Support custom protocol, no matter your protocol is a command line protocol or a binary one. Another open source project SuperWebSocket is built upon SuperSocket and take advantage of this custom protocol feature of it.
Support SSL/TLS encryption automatically
Support multiple socket server instances. You can define many socket servers on different ports in configuration, SuperSocket can run those servers in the same application/service
SuperSocket can run as console application and windows service. It provide a bat file to install SuperSocket as a windows service.
Flexible logging strategy which can log most of socket activities
Also support UDP socket
Support IPv6
Support Windows Azure
Support running in Unix system (by Mono 2.10 or above version)
Built-in socket policy server for Flash and Silverlight clients which you can use directly

Donate:

Documentation:

Documentation
Road Map

SuperSocket Extensions: http://supersocketext.codeplex.com/

Github: https://github.com/kerryjiang/SuperSocket

Consult/feature request/paid project customization:

kerry-jiang@hotmail.com

Skype: kerry-jiang

Facebook: http://www.facebook.com/supersocket

Author's LinkedIn profile: http://www.linkedin.com/in/kerryjiang

LinkedIn Group: http://www.linkedin.com/groups/SuperSocket-User-Group-3821247

QQ Group: 135969383

SuperSocket ClientEngine - Recommended Socket Client Component

http://clientengine.codeplex.com/

Updated Wiki: Home

kerryjiang — Wed, 24 Apr 2013 15:52:29 GMT

Latest stable release:

SuperSocket 1.5.2 https://supersocket.codeplex.com/releases/view/104825

Features:

Very easy to use. You can create a robust socket server only by several classes
Support custom protocol, no matter your protocol is a command line protocol or a binary one. Another open source project SuperWebSocket is built upon SuperSocket and take advantage of this custom protocol feature of it.
Support SSL/TLS encryption automatically
Support multiple socket server instances. You can define many socket servers on different ports in configuration, SuperSocket can run those servers in the same application/service
SuperSocket can run as console application and windows service. It provide a bat file to install SuperSocket as a windows service.
Flexible logging strategy which can log most of socket activities
Also support UDP socket
Support IPv6
Support Windows Azure
Support running in Unix system (by Mono 2.10 or above version)
Built-in socket policy server for Flash and Silverlight clients which you can use directly

Donate:

Documentation:

Documentation
Road Map

SuperSocket Extensions: http://supersocketext.codeplex.com/

Github: https://github.com/kerryjiang/SuperSocket

Consult/feature request/paid project customization:

kerry-jiang@hotmail.com

Skype: kerry-jiang

Facebook: http://www.facebook.com/supersocket

Author's LinkedIn profile: http://www.linkedin.com/in/kerryjiang

LinkedIn Group: http://www.linkedin.com/groups/SuperSocket-User-Group-3821247

QQ Group: 135969383

SuperSocket ClientEngine - Recommended Socket Client Component

http://clientengine.codeplex.com/

Updated Wiki: Documentation

kerryjiang — Wed, 24 Apr 2013 14:41:20 GMT

SuperSocket Documentation

* The above pictures are for SuperSocket 1.5.

Road Map
SuperSocket 1.4 Documentation
SuperSocket 1.5 Documentation
QuickStart: QuickStart contains lots of sample projects which locates in the source code

New Comment on "A Telnet Example"

madxzb — Thu, 18 Apr 2013 06:45:51 GMT

此例子在vs2008+c#3.5上，运行连接报异常。

Updated Wiki: SuperSocket 1.5 Documentation

kerryjiang — Fri, 12 Apr 2013 09:50:45 GMT

If you have other topic you are interested in, please leave your comment or mail to: kerry-jiang@hotmail.com.

Updated Wiki: Known Issues

kerryjiang — Fri, 12 Apr 2013 09:49:56 GMT

Known Issues in SuperSocket 1.5

Send data to client in the NewSessionConnected event handler

If you send data to client immediately in the NewSessionConnected event handler, a Null Reference exception will be thrown. You can change your code to send the welcome message to client in the override method of OnSessionStarted of your AppSession class instead.

Updated Wiki: Home

kerryjiang — Thu, 11 Apr 2013 03:03:40 GMT

Latest stable release:

SuperSocket 1.5.2 https://supersocket.codeplex.com/releases/view/104825

Features:

Very easy to use. You can create a robust socket server only by several classes
Support custom protocol, no matter your protocol is a command line protocol or a binary one. Another open source project SuperWebSocket is built upon SuperSocket and take advantage of this custom protocol feature of it.
Support SSL/TLS encryption automatically
Support multiple socket server instances. You can define many socket servers on different ports in configuration, SuperSocket can run those servers in the same application/service
SuperSocket can run as console application and windows service. It provide a bat file to install SuperSocket as a windows service.
Flexible logging strategy which can log most of socket activities
Also support UDP socket
Support IPv6
Support Windows Azure
Support running in Unix system (by Mono 2.10 or above version)
Built-in socket policy server for Flash and Silverlight clients which you can use directly

Donate:

Documentation:

Documentation
Road Map

SuperSocket Extensions: http://supersocketext.codeplex.com/

Github: https://github.com/kerryjiang/SuperSocket

SuperSocket Binaries:

svn: https://subversion.assembla.com/svn/supersocket-svn/
git: https://git.assembla.com/supersocket-git.git

Consult/feature request/paid project customization:

kerry-jiang@hotmail.com

Skype: kerry-jiang

Facebook: http://www.facebook.com/supersocket

Author's LinkedIn profile: http://www.linkedin.com/in/kerryjiang

LinkedIn Group: http://www.linkedin.com/groups/SuperSocket-User-Group-3821247

QQ Group: 135969383

SuperSocket ClientEngine - Recommended Socket Client Component

http://clientengine.codeplex.com/

Updated Wiki: Road Map

kerryjiang — Tue, 09 Apr 2013 05:56:03 GMT

Road Map of SuperSocket

Fix issues in socket communications
Small improvements about structure, performance, configuration, etc
Implemented the best practice of async socket communication using SocketAsyncEventArgs and BufferManager
Independent logging files for each socket server instance
Added more examples in QuickStart, and improved QuickStart projects' solution structure
SuperSocket v1.0 stable (Oct 11, 2010)
-----------------------------------------------------------------------------------------------------

.Net 4.0
Upgrade EntLib to 5.0
UDP socket support
Support custom protocol
SSL/TLS encryption communication support (only support in Sync mode)
Change to use Log4Net for logging to support Mono
IPv6 support
Max command length limitation(security fix)
SuperSocket v1.3 stable (Jan 15, 2011)
------------------------------------------------------------------------------------------------------

Concurrency & performance improvement
Use TPL in SuperSocket
Mono support
Command filter support (like Action Filter in ASP.NET MVC)
Connection filter support
Windows Azure support
Built-In Policy Server for Flash and Silverlight client
Multiple command assemblies
SuperSocket v1.4 stable (Jul 12, 2011)
SuperSocket v1.4 SP1 (Sep 20, 2011)
SSL/TLS encryption communication support in async mode (base on async reading and writing of SslStream)
SuperSocket v1.4 SP2 (Dec 28, 2011)
SuperSocket v1.4 SP3 (Feb 19, 2012)
SuperSocket v1.4 SP4 (Apr 17, 2012)
SuperSocket v1.4 SP5 (Jul 30, 2012)
SuperSocket v1.4.6 (Nov 14, 2012)
------------------------------------------------------------------------------------------------------

Dynamic language support
Better Mono Support
Improve logging architecture to support logging libraries other than log4net
Improve CustomProtocol
AppDomain level isolation for socket server instances
Improve sending performance
Listen multiple ip/port in one instance
.NET 4.5 supprot
Other small enhancements
SuperSocket v1.5 stable (Jan 07, 2013)
SuperSocket v1.5.1 (Feb 5, 2013)
-----------------------------------------------------------------------------------------------------

Process level isolation for multiple server instances
Global culture setting (only for .NET 4.5)
SuperSocket 1.6 stable (2013 Q2)
-----------------------------------------------------------------------------------------------------

Localization
Configuration arguments hot update
Improve the performance of the built-in session container
Improve the perforamnce of the built-in receive filters
Intelligent receiving/sending buffer managment
Performance improvement about sending same content to many different clients
Receiving buffer protocol analysis reusing improvement
Request processing scheduler
Selectable command loading
Direct UDP group broadcasting support
Timing start/stop/restart
SuperSocket 1.? stable (2013)
-----------------------------------------------------------------------------------------------------

Change to use async patterns of .NET 4.5
Use MEF to implement extensibility
Serial port communication support (modbus)
F# Integration?
Hot upgrade
A built-in object transferring protocol and client (Move to SuperSocket Extensions)
Built-in XMPP protocol support? (Move to SuperSocket Extensions)
Built-in Protocol Buffers support? (Move to SuperSocket Extensions)
TCP/IP security enhancement

Your ideas, suggestions and feature requests (mailto: kerry-jiang@hotmail.com)

Updated Wiki: Road Map

kerryjiang — Tue, 09 Apr 2013 05:52:15 GMT

Road Map of SuperSocket

Fix issues in socket communications
Small improvements about structure, performance, configuration, etc
Implemented the best practice of async socket communication using SocketAsyncEventArgs and BufferManager
Independent logging files for each socket server instance
Added more examples in QuickStart, and improved QuickStart projects' solution structure
SuperSocket v1.0 stable (Oct 11, 2010)
-----------------------------------------------------------------------------------------------------

.Net 4.0
Upgrade EntLib to 5.0
UDP socket support
Support custom protocol
SSL/TLS encryption communication support (only support in Sync mode)
Change to use Log4Net for logging to support Mono
IPv6 support
Max command length limitation(security fix)
SuperSocket v1.3 stable (Jan 15, 2011)
------------------------------------------------------------------------------------------------------

Concurrency & performance improvement
Use TPL in SuperSocket
Mono support
Command filter support (like Action Filter in ASP.NET MVC)
Connection filter support
Windows Azure support
Built-In Policy Server for Flash and Silverlight client
Multiple command assemblies
SuperSocket v1.4 stable (Jul 12, 2011)
SuperSocket v1.4 SP1 (Sep 20, 2011)
SSL/TLS encryption communication support in async mode (base on async reading and writing of SslStream)
SuperSocket v1.4 SP2 (Dec 28, 2011)
SuperSocket v1.4 SP3 (Feb 19, 2012)
SuperSocket v1.4 SP4 (Apr 17, 2012)
SuperSocket v1.4 SP5 (Jul 30, 2012)
SuperSocket v1.4.6 (Nov 14, 2012)
------------------------------------------------------------------------------------------------------

Dynamic language support
Better Mono Support
Improve logging architecture to support logging libraries other than log4net
Improve CustomProtocol
AppDomain level isolation for socket server instances
Improve sending performance
Listen multiple ip/port in one instance
.NET 4.5 supprot
Other small enhancements
SuperSocket v1.5 stable (Jan 07, 2013)
SuperSocket v1.5.1 (Feb 5, 2013)
-----------------------------------------------------------------------------------------------------

Process level isolation for multiple server instances
Global culture setting (only for .NET 4.5)
SuperSocket 1.6 stable (2013 Q2)
-----------------------------------------------------------------------------------------------------

Localization
Configuration arguments hot update
Improve the performance of the built-in session container
Improve the perforamnce of the built-in receive filters
Intelligent receiving/sending buffer managment
Performance improvement about sending same content to many different clients
Receiving buffer protocol analysis reusing improvement
Request processing scheduler
Selectable command loading
Direct UDP group broadcasting support
Timing start/stop/restart
SuperSocket 1.? stable (2013)
-----------------------------------------------------------------------------------------------------

Change to use async patterns of .NET 4.5
Use MEF to implement extensibility
F# Integration?
Hot upgrade
A built-in object transferring protocol and client (Move to SuperSocket Extensions)
Built-in XMPP protocol support? (Move to SuperSocket Extensions)
Built-in Protocol Buffers support? (Move to SuperSocket Extensions)
Serial port communication support (modbus)?
TCP/IP security enhancement

Your ideas, suggestions and feature requests (mailto: kerry-jiang@hotmail.com)

Updated Wiki: Road Map

kerryjiang — Tue, 09 Apr 2013 05:51:07 GMT

Road Map of SuperSocket

Fix issues in socket communications
Small improvements about structure, performance, configuration, etc
Implemented the best practice of async socket communication using SocketAsyncEventArgs and BufferManager
Independent logging files for each socket server instance
Added more examples in QuickStart, and improved QuickStart projects' solution structure
SuperSocket v1.0 stable (Oct 11, 2010)
-----------------------------------------------------------------------------------------------------

.Net 4.0
Upgrade EntLib to 5.0
UDP socket support
Support custom protocol
SSL/TLS encryption communication support (only support in Sync mode)
Change to use Log4Net for logging to support Mono
IPv6 support
Max command length limitation(security fix)
SuperSocket v1.3 stable (Jan 15, 2011)
------------------------------------------------------------------------------------------------------

Concurrency & performance improvement
Use TPL in SuperSocket
Mono support
Command filter support (like Action Filter in ASP.NET MVC)
Connection filter support
Windows Azure support
Built-In Policy Server for Flash and Silverlight client
Multiple command assemblies
SuperSocket v1.4 stable (Jul 12, 2011)
SuperSocket v1.4 SP1 (Sep 20, 2011)
SSL/TLS encryption communication support in async mode (base on async reading and writing of SslStream)
SuperSocket v1.4 SP2 (Dec 28, 2011)
SuperSocket v1.4 SP3 (Feb 19, 2012)
SuperSocket v1.4 SP4 (Apr 17, 2012)
SuperSocket v1.4 SP5 (Jul 30, 2012)
SuperSocket v1.4.6 (Nov 14, 2012)
------------------------------------------------------------------------------------------------------

Dynamic language support
Better Mono Support
Improve logging architecture to support logging libraries other than log4net
Improve CustomProtocol
AppDomain level isolation for socket server instances
Improve sending performance
Listen multiple ip/port in one instance
.NET 4.5 supprot
Other small enhancements
SuperSocket v1.5 stable (Jan 07, 2013)
SuperSocket v1.5.1 (Feb 5, 2013)
-----------------------------------------------------------------------------------------------------

Process level isolation for multiple server instances
Global culture setting (only for .NET 4.5)
SuperSocket 1.6 stable (2013 Q2)
-----------------------------------------------------------------------------------------------------

Localization
Configuration arguments hot update
Improve the performance of the built-in session container
Improve the perforamnce of the built-in receive filters
Intelligent receiving/sending buffer managment
Performance improvement about sending same content to many different clients
Receiving buffer protocol analysis reusing improvement
Request processing scheduler
Selectable command loading
Direct UDP group broadcasting support
Timing start/stop/restart
SuperSocket 1.? stable (2013)
-----------------------------------------------------------------------------------------------------

Change to use async patterns of .NET 4.5
Use MEF to implement extensibility
F# Integration?
Hot upgrade
A built-in object transferring protocol and client (Move to SuperSocket Extensions)
Built-in XMPP protocol support? (Move to SuperSocket Extensions)
Built-in Protocol Buffers support? (Move to SuperSocket Extensions)
Serial port communication support? (Move to SuperSocket Extensions)
TCP/IP security enhancement

Your ideas, suggestions and feature requests (mailto: kerry-jiang@hotmail.com)

Updated Wiki: Road Map

kerryjiang — Tue, 09 Apr 2013 05:48:29 GMT

Road Map of SuperSocket

Fix issues in socket communications
Small improvements about structure, performance, configuration, etc
Implemented the best practice of async socket communication using SocketAsyncEventArgs and BufferManager
Independent logging files for each socket server instance
Added more examples in QuickStart, and improved QuickStart projects' solution structure
SuperSocket v1.0 stable (Oct 11, 2010)
-----------------------------------------------------------------------------------------------------

.Net 4.0
Upgrade EntLib to 5.0
UDP socket support
Support custom protocol
SSL/TLS encryption communication support (only support in Sync mode)
Change to use Log4Net for logging to support Mono
IPv6 support
Max command length limitation(security fix)
SuperSocket v1.3 stable (Jan 15, 2011)
------------------------------------------------------------------------------------------------------

Concurrency & performance improvement
Use TPL in SuperSocket
Mono support
Command filter support (like Action Filter in ASP.NET MVC)
Connection filter support
Windows Azure support
Built-In Policy Server for Flash and Silverlight client
Multiple command assemblies
SuperSocket v1.4 stable (Jul 12, 2011)
SuperSocket v1.4 SP1 (Sep 20, 2011)
SSL/TLS encryption communication support in async mode (base on async reading and writing of SslStream)
SuperSocket v1.4 SP2 (Dec 28, 2011)
SuperSocket v1.4 SP3 (Feb 19, 2012)
SuperSocket v1.4 SP4 (Apr 17, 2012)
SuperSocket v1.4 SP5 (Jul 30, 2012)
------------------------------------------------------------------------------------------------------

Dynamic language support
Better Mono Support
Improve logging architecture to support logging libraries other than log4net
Improve CustomProtocol
AppDomain level isolation for socket server instances
Improve sending performance
Listen multiple ip/port in one instance
.NET 4.5 supprot
Other small enhancements
SuperSocket v1.5 stable (Jan 07, 2013)
-----------------------------------------------------------------------------------------------------

Process level isolation for multiple server instances
Global culture setting (only for .NET 4.5)
SuperSocket 1.6 stable (2013 Q2)
-----------------------------------------------------------------------------------------------------

Localization
Configuration arguments hot update
Improve the performance of the built-in session container
Improve the perforamnce of the built-in receive filters
Intelligent receiving/sending buffer managment
Performance improvement about sending same content to many different clients
Receiving buffer protocol analysis reusing improvement
Request processing scheduler
Selectable command loading
Direct UDP group broadcasting support
Timing start/stop/restart
SuperSocket 1.? stable (2013)
-----------------------------------------------------------------------------------------------------

Change to use async patterns of .NET 4.5
Use MEF to implement extensibility
F# Integration?
Hot upgrade
A built-in object transferring protocol and client (Move to SuperSocket Extensions)
Built-in XMPP protocol support? (Move to SuperSocket Extensions)
Built-in Protocol Buffers support? (Move to SuperSocket Extensions)
Serial port communication support? (Move to SuperSocket Extensions)
TCP/IP security enhancement

Your ideas, suggestions and feature requests (mailto: kerry-jiang@hotmail.com)

Updated Wiki: Run SuperSocket in Unix/Linux by Mono

kerryjiang — Mon, 08 Apr 2013 16:14:14 GMT

SuperSocket supports cross-platform compatibility (Unix/Linux) of .NET applications by Mono (Mono 2.10 or later version)

As the Unix/Linux has different file path format with Windows, SuperSocket provides a different log4net configuration file (/Solution Items/log4net.unix.config) for Unix/Linux systems.

Therefore, you need to include this file to your project in subdirectory "Config" of output directory.

In Unix/Linux operating system, SuperSocket also can run as a console application or a service (Mono Service) like it in Windows.

Console:

mono SuperSocket.SocketService.exe

Mono Service:

mono-service -l:supersocket.lock -m:supersocket.log -d:<workdir> SuperSocket.SocketService.exe

The parameter <workdir> is required, it is the root of your application where the file SuperSocket.SocketService.exe locates.

Updated Wiki: Run SuperSocket in Unix/Linux by Mono

kerryjiang — Mon, 08 Apr 2013 16:13:41 GMT

SuperSocket supports cross-platform compatibility (Unix/Linux) of .NET applications by Mono (Mono 2.10 or later version)
As the Unix/Linux has different file path format with Windows, SuperSocket provides a different log4net configuration file (/Solution Items/log4net.unix.config) for Unix/Linux systems.

Therefore, you need to include this file to your project in subdirectory "Config" of output directory.

In Unix/Linux operating system, SuperSocket also can run as a console application or a service (Mono Service) like it in Windows.

Console:

mono SuperSocket.SocketService.exe
Mono Service:

mono-service -l:supersocket.lock -m:supersocket.log -d:<workdir> SuperSocket.SocketService.exe
The parameter <workdir> is required, it is the root of your application where the file SuperSocket.SocketService.exe locates.

Updated Wiki: SuperSocket Basic Configuration

kerryjiang — Sat, 06 Apr 2013 09:57:19 GMT

A Sample Configuration

<?xml version="1.0"?>
<configuration>
    <configSections>
        <section name="superSocket"
                 type="SuperSocket.SocketEngine.Configuration.SocketServiceConfig, SuperSocket.SocketEngine" />
    </configSections>
    <appSettings>
        <add key="ServiceName" value="SupperSocketService" />
    </appSettings>
    <superSocket>
        <servers>
            <server name="TelnetServerA"
                    serverTypeName="TelnetServer"
                    ip="Any"
                    port="2020">
            </server>
            <server name="TelnetServerB"
                    serverTypeName="TelnetServer"
                    ip="Any"
                    port="2021">
            </server>
        </servers>
        <serverTypes>
            <add name="TelnetServer"
                 type="SuperSocket.QuickStart.TelnetServer_StartByConfig.TelnetServer, SuperSocket.QuickStart.TelnetServer_StartByConfig"/>
        </serverTypes>
    </superSocket>
    <startup>
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0" />
    </startup>
</configuration>

Root Configuration

The configuration node "superSocket" is the root of the SuperSocket configuration, it defines the global parameters of SuperSocket requires. Let me explain all the attributes of the root node:

maxWorkingThreads: maximum working threads count of .NET thread pool
minWorkingThreads: minimum working threads count of .NET thread pool
maxCompletionPortThreads: maximum completion threads count of .NET thread pool
minCompletionPortThreads: minimum completion threads count of .NET thread pool
disablePerformanceDataCollector: whether disable performance data collector
performanceDataCollectInterval: performance data collecting interval (in seconds, default value: 60)
isolation: SuperSocket instances isolation level
- None - no isolation
- AppDomain - server instances will be isolated by AppDomains
logFactory: the name of default logFactory, all log factories are defined in the child node "logFactories" which will be introduced in following documentation

Servers Configuration

In the root configuration node, there is child node named "servers", you can define one or many server configuration nodes in it which represent app server instances. The server instances can be same AppServer type, also can be different AppServer types. All server node's attributes:

name: the name of the server instance
serverType: the full name the AppServer's type which you want to run
serverTypeName: the name of the selected server types, all server types should be defined in serverTypes node which will be introduced in following documentation
ip: the ip of the server instance listens. You can set an exact ip, you also can set the below values Any - all IPv4 address IPv6Any - all IPv6 address
port: the port of the server instance listens
listenBacklog: the listen back log size
mode: the socket server's running mode, Tcp (default) or Udp
disabled: whether the server instance is disabled
startupOrder: the server instance start order, the bootstrap will start all server instances order by this value
sendTimeOut: sending data timeout
sendingQueueSize: the sending queue's maximum size
maxConnectionNumber: maximum connection number the server instance allow to connect at the same time
receiveBufferSize: receiving buffer size
sendBufferSize: sending buffer size
syncSend: sending data in sync mode, default value: false
logCommand: whether log command execution record
logBasicSessionActivity: whether log the session's basic activities like connected and closed
clearIdleSession: true or false, whether clear idle sessions. Default value is false.
clearIdleSessionInterval: the clearing timeout idle session interval. Default value is 120, in seconds.
idleSessionTimeOut: The session timeout period. Default value is 300, in seconds.
security: Empty, Tls, Ssl3. The security option of the socket server. Default value is empty.
maxRequestLength: The maximum allowed request length. Default value is 1024.
disableSessionSnapshot: Indicate whether disable session snapshot. Default value is false.
sessionSnapshotInterval: The interval of taking session snapshot. Default value is 5, in seconds.
keepAliveTime: The interval of keeping alive. Default value is 600, in seconds.
keepAliveInterval: The interval of retry after keep alive fail. Default value is 60, in seconds.
certificate: it is a configuration element for X509Certificate which will be used in this server instance

there are two usage:
- one is load certificate from cert file
```
  <certificate filePath="localhost.pfx" password="supersocket" />
```
- another one is load certificate from local certificate storage
```
  <certificate storeName="My" thumbprint="‎f42585bceed2cb049ef4a3c6d0ad572a6699f6f3"/>
```
connectionFilter: the name of the connection filter you want to use for this server instance, multiple filters should be delimited by ',' or ';'. Connection filters should be defined in a child nodes of root node which will be introduced in the following documentation
commandLoader: the name of the command loader you want to use for this server instance, multiple loaders should be delimited by ',' or ';'. Command loaders should be defined in a child nodes of root node which will be introduced in the following documentation
logFactory: the log factory you want to use for this server instance. If you don't set it, the log factory defined in root configuration will be used

listeners: it is an configuration element which is designed for supporting multiple listening ip/port pair in one server instance. The listeners node should contains one or more child nodes of listener whose attributes defined like below:

ip: the listening ip
port: the listening port
backlog: the listening back log size
security: the security mode (None/Default/Tls/Ssl/...)

for examples:

<server name="EchoServer" serverTypeName="EchoService">
  <listeners>
    <add ip="Any" port="2012" />
    <add ip="IPv6Any" port="2012" />
  </listeners>
</server>

requestFilterFactory: the name of the request filter factory you want to use it for this server instance

Server Types Configuration

Server types node is a collection configuration node under the root. You are able to add one/more elements with element name "add" and attributes "name" and "type":

    <serverTypes>
        <add name="TelnetServerType"
             type="SuperSocket.QuickStart.TelnetServer_StartByConfig.TelnetServer, SuperSocket.QuickStart.TelnetServer_StartByConfig"/>
    </serverTypes>

Because of the defined server type's name is "TelnetServerType", you can set the config attribute "serverTypeName" of the server instances you want to run as this type to be "TelnetServerType":

    <server name="TelnetServerA"
            serverTypeName="TelnetServerType"
            ip="Any"
            port="2020">
    </server>

Log Factories Configuration

Same as server type configuration, you also can define one or more log factories and use it in server, the only one difference is the log factory also can be set in root configuration:

<logFactories>
  <add name="ConsoleLogFactory"
       type="SuperSocket.SocketBase.Logging.ConsoleLogFactory, SuperSocket.SocketBase" />
</logFactories>

Use it in root configuration:

<superSocket logFactory="ConsoleLogFactory">
    ...
    ...
</superSocket>

Use it in server node:

<server name="TelnetServerA"
       logFactory="ConsoleLogFactory"
       ip="Any"
       port="2020">
</server>

Updated Wiki: The Built-in Common Format Protocol Implementation Tools

kerryjiang — Wed, 03 Apr 2013 04:47:30 GMT

After reading the previous document, you probably find implementing your own protocol using SuperSocket probably is not easy for you. To make this job easier, SuperSocket provides some common protocol tools, which you can use to build your own protocol easily and fast:

TerminatorReceiveFilter
CountSpliterReceiveFilter
FixedSizeReceiveFilter
BeginEndMarkReceiveFilter
FixedHeaderReceiveFilter

Terminator Protocol

Similar with command line protocol, some protocols use a terminator to identify a request. For example, one protocol uses two chars "##" as terminator, then you can use the class "TerminatorReceiveFilterFactory":

/// <summary>
/// TerminatorProtocolServer
/// Each request end with the terminator "##"
/// ECHO Your message##
/// </summary>
public class TerminatorProtocolServer : AppServer
{
    public TerminatorProtocolServer()
        : base(new TerminatorReceiveFilterFactory("##"))
    {

    }
}

The default RequestInfo is StringRequestInfo, you also can create your own RequestInfo class, but it requires a bit more work:

Implement your ReceiveFilter base on TerminatorReceiveFilter:

public class YourReceiveFilter : TerminatorReceiveFilter<YourRequestInfo>
{
    //More code
}

Implement your ReceiveFilterFactory which can create your request filter instances:

public class YourReceiveFilterFactory : IReceiveFilterFactory<YourRequestInfo>
{
    //More code
}

And then use the request filter factory in your AppServer.

Fixed Number Split Parts with Separator Protocol

Some protocols defines their requests look like in the format of "#part1#part2#part3#part4#part5#part6#part7#". There are 7 parts in one request and all parts are separated by char '#'. This kind protocol's implementing also is quite easy:

/// <summary>
/// Your protocol likes like the format below:
/// #part1#part2#part3#part4#part5#part6#part7#
/// </summary>
public class CountSpliterAppServer : AppServer
{
    public CountSpliterAppServer()
        : base(new CountSpliterReceiveFilterFactory((byte)'#', 8)) // 7 parts but 8 separators
    {

    }
}

You also can customize your protocol deeper using the classes below:

CountSpliterReceiveFilter<TRequestInfo>
CountSpliterReceiveFilterFactory<TReceiveFilter>
CountSpliterReceiveFilterFactory<TReceiveFilter, TRequestInfo>

Fixed Header with Body Length Protocol

This kind protocol defines each request has two parts, the first part contains some basic information of this request include the length of the second part. We usually call the first part is header and the second part is body.

For example, we have a protocol like that: the header contains 6 bytes, the first 4 bytes represent the request's name, the last 2 bytes represent the length of the body:

/// +-------+---+-------------------------------+
/// |request| l |                               |
/// | name  | e |    request body               |
/// |  (4)  | n |                               |
/// |       |(2)|                               |
/// +-------+---+-------------------------------+

Using SuperSocket, you can implement this kind protocol easily:

class MyReceiveFilter : FixedHeaderReceiveFilter<BinaryRequestInfo>
{
    public MyReceiveFilter()
        : base(6)
    {

    }

    protected override int GetBodyLengthFromHeader(byte[] header, int offset, int length)
    {
        return (int)header[offset + 4] * 256 + (int)header[offset + 5];
    }

    protected override BinaryRequestInfo ResolveRequestInfo(ArraySegment<byte> header, byte[] bodyBuffer, int offset, int length)
    {
        return new BinaryRequestInfo(Encoding.UTF8.GetString(header.Array, header.Offset, 4), bodyBuffer.CloneRange(offset, length));
    }
}

You need to implement your own request filter base on FixedHeaderReceiveFilter.

The number 6 passed into the parent class's constructor means the size of the request header;
The method "GetBodyLengthFromHeader(...)" you should override returns the length of the body according the received header;
the method "ResolveRequestInfo(....)" you should override returns the RequestInfo instance according the received header and body.

Then you can build a receive filter factory or use the default receive factory to use this receive filter in SuperSocket.

Updated Wiki: Road Map

kerryjiang — Fri, 29 Mar 2013 16:10:25 GMT

Road Map of SuperSocket

Fix issues in socket communications
Small improvements about structure, performance, configuration, etc
Implemented the best practice of async socket communication using SocketAsyncEventArgs and BufferManager
Independent logging files for each socket server instance
Added more examples in QuickStart, and improved QuickStart projects' solution structure
SuperSocket v1.0 stable (Oct 11, 2010)
-----------------------------------------------------------------------------------------------------

.Net 4.0
Upgrade EntLib to 5.0
UDP socket support
Support custom protocol
SSL/TLS encryption communication support (only support in Sync mode)
Change to use Log4Net for logging to support Mono
IPv6 support
Max command length limitation(security fix)
SuperSocket v1.3 stable (Jan 15, 2011)
------------------------------------------------------------------------------------------------------

Concurrency & performance improvement
Use TPL in SuperSocket
Mono support
Command filter support (like Action Filter in ASP.NET MVC)
Connection filter support
Windows Azure support
Built-In Policy Server for Flash and Silverlight client
Multiple command assemblies
SuperSocket v1.4 stable (Jul 12, 2011)
SuperSocket v1.4 SP1 (Sep 20, 2011)
SSL/TLS encryption communication support in async mode (base on async reading and writing of SslStream)
SuperSocket v1.4 SP2 (Dec 28, 2011)
SuperSocket v1.4 SP3 (Feb 19, 2012)
SuperSocket v1.4 SP4 (Apr 17, 2012)
SuperSocket v1.4 SP5 (Jul 30, 2012)
------------------------------------------------------------------------------------------------------

Dynamic language support
Better Mono Support
Improve logging architecture to support logging libraries other than log4net
Improve CustomProtocol
AppDomain level isolation for socket server instances
Improve sending performance
Listen multiple ip/port in one instance
.NET 4.5 supprot
Other small enhancements
SuperSocket v1.5 stable (Jan 07, 2013)
-----------------------------------------------------------------------------------------------------

Process level isolation for multiple server instances
Global culture setting (only for .NET 4.5)
Configuration arguments hot update
SuperSocket 1.6 stable (2013 Q1)
-----------------------------------------------------------------------------------------------------

Localization
Improve the performance of the built-in session container
Improve the perforamnce of the built-in receive filters
Intelligent receiving/sending buffer managment
Performance improvement about sending same content to many different clients
Receiving buffer protocol analysis reusing improvement
Request processing scheduler
Selectable command loading
Direct UDP group broadcasting support
Timing start/stop/restart
SuperSocket 1.? stable (2013)
-----------------------------------------------------------------------------------------------------

Change to use async patterns of .NET 4.5
Use MEF to implement extensibility
F# Integration?
Hot upgrade
A built-in object transferring protocol and client (Move to SuperSocket Extensions)
Built-in XMPP protocol support? (Move to SuperSocket Extensions)
Built-in Protocol Buffers support? (Move to SuperSocket Extensions)
Serial port communication support? (Move to SuperSocket Extensions)
TCP/IP security enhancement

Your ideas, suggestions and feature requests (mailto: kerry-jiang@hotmail.com)

Updated Wiki: The Built-in Command Line Protocol

kerryjiang — Sat, 09 Mar 2013 15:28:07 GMT

What's the Protocol?

What's the Protocol? Lots of people probably will answer "TCP" or "UDP". But to build a network application, only TCP or UDP is not enough. TCP and UDP are transport-layer protocols. It's far from enough to enable talking between two endpoints in the network if you only define transport-layer protocol. You need to define your application level protocol to convert your received binary data to the requests which your application can understand.

The Built-in Command Line Protocol

The command line protocol is a widely used protocols, lots of protocols like Telnet, SMTP, POP3 and FTP protocols are base on command line protocol etc. If you do not have a custom protocol, then SuperSocket will use command line protocol by default, which can simplify the development of this kind of protocols.

The command line protocol defines each request must be ended with a carriage return "\r\n".

If you use the command line protocol in SuperSocket, all requests will to translated into StringRequestInfo instances.

StringRequestInfo is defined like this:

public class StringRequestInfo
{
    public string Key { get; }

    public string Body { get; }

    public string[] Parameters { get; }

    /*
    Other properties and methods
    */
}

Because the built-in command line protocol in SuperSocket uses a space to split request key and parameters, So when the client sends the data below to the server:

"LOGIN kerry 123456" + NewLine

the SuperSocket server will receive a StringRequestInfo instance, the properties of the request info instance will be:

Key: "LOGIN"
Body: "kerry 123456";
Parameters: ["kerry", "123456"]

If you have defined a Command with name "LOGIN", the command's ExecuteCommand method will be excuted with the StringRequestInfo instance as parameter:

public class LOGIN : CommandBase<AppSession, StringRequestInfo>
{
    public override void ExecuteCommand(AppSession session, StringRequestInfo requestInfo)
    {
        //Implement your business logic
    }
}

Customize the Command Line Protocol

Some users might have different request format, for instance:

"LOGIN:kerry,12345" + NewLine

The request's key is separated with body by the char ':', and the parameters are separated by the char ','. This kind of request can be supported easily, just extend the command line protocol like the below code:

public class YourServer : AppServer<YourSession>
{
    public YourServer()
        : base(new CommandLineReceiveFilterFactory(Encoding.Default, new BasicRequestInfoParser(":", ",")))
    {

    }
}

If you want to customize the request format much deeper, you can implement a RequestInfoParser class base the interface IRequestInfoParser, and then pass in your own RequestInfoParser instance when instantiate the CommandLineReceiveFilterFactory instance:

public class YourServer : AppServer<YourSession>
{
    public YourServer()
        : base(new CommandLineReceiveFilterFactory(Encoding.Default, new YourRequestInfoParser()))
    {

    }
}

Text Encoding

The default encoding of the command line protocol is Ascii. You can change to other encoding than Ascii by instantiating CommandLineReceiveFilterFactory with the specific enoding:

public class YourServer : AppServer<YourSession>
{
    public YourServer()
        : base(new CommandLineReceiveFilterFactory(Encoding.UTF8))
    {

    }
}

New Comment on "A Telnet Example"

OLDBIG12 — Wed, 06 Mar 2013 03:17:43 GMT

Well, StringRequestInfo is in namespace SuperSocket.SocektBase, you should just add the using at the beginning of your code.

Updated Wiki: Home

kerryjiang — Tue, 19 Feb 2013 15:40:31 GMT

Latest stable release:

SuperSocket 1.5.1 http://supersocket.codeplex.com/releases/view/101376

Features:

Very easy to use. You can create a robust socket server only by several classes
Support custom protocol, no matter your protocol is a command line protocol or a binary one. Another open source project SuperWebSocket is built upon SuperSocket and take advantage of this custom protocol feature of it.
Support SSL/TLS encryption automatically
Support multiple socket server instances. You can define many socket servers on different ports in configuration, SuperSocket can run those servers in the same application/service
SuperSocket can run as console application and windows service. It provide a bat file to install SuperSocket as a windows service.
Flexible logging strategy which can log most of socket activities
Also support UDP socket
Support IPv6
Support Windows Azure
Support running in Unix system (by Mono 2.10 or above version)
Built-in socket policy server for Flash and Silverlight clients which you can use directly

Donate:

Documentation:

Documentation
Road Map

SuperSocket Extensions: http://supersocketext.codeplex.com/

Github: https://github.com/kerryjiang/SuperSocket

SuperSocket Binaries:

svn: https://subversion.assembla.com/svn/supersocket-svn/
git: https://git.assembla.com/supersocket-git.git

Consult/feature request/paid project customization:

kerry-jiang@hotmail.com

Skype: kerry-jiang

Facebook: http://www.facebook.com/supersocket

Author's LinkedIn profile: http://www.linkedin.com/in/kerryjiang

LinkedIn Group: http://www.linkedin.com/groups/SuperSocket-User-Group-3821247

QQ Group: 135969383

SuperSocket ClientEngine - Recommended Socket Client Component

http://clientengine.codeplex.com/

Updated Wiki: Home

kerryjiang — Tue, 05 Feb 2013 05:33:21 GMT

Latest stable release:

SuperSocket 1.5.1 http://supersocket.codeplex.com/releases/view/101376

Features:

Very easy to use. You can create a robust socket server only by several classes
Support custom protocol, no matter your protocol is a command line protocol or a binary one. Another open source project SuperWebSocket is built upon SuperSocket and take advantage of this custom protocol feature of it.
Support SSL/TLS encryption automatically
Support multiple socket server instances. You can define many socket servers on different ports in configuration, SuperSocket can run those servers in the same application/service
SuperSocket can run as console application and windows service. It provide a bat file to install SuperSocket as a windows service.
Flexible logging strategy which can log most of socket activities
Also support UDP socket
Support IPv6
Support Windows Azure
Support running in Unix system (by Mono 2.10 or above version)
Built-in socket policy server for Flash and Silverlight clients which you can use directly

Donate:

Documentation:

Documentation
Road Map

SuperSocket Extensions: http://supersocketext.codeplex.com/

Github: https://github.com/kerryjiang/SuperSocket

SuperSocket Binaries:

svn: https://subversion.assembla.com/svn/supersocket-svn/
git: https://git.assembla.com/supersocket-git.git

Consult/feature request/paid project customization:

kerry-jiang@hotmail.com

Skype: kerry-jiang

Facebook: http://www.facebook.com/supersocket

Author's LinkedIn profile: http://cn.linkedin.com/in/kerryjiang

LinkedIn Group: http://www.linkedin.com/groups/SuperSocket-User-Group-3821247

QQ Group: 135969383

SuperSocket ClientEngine - Recommended Socket Client Component

http://clientengine.codeplex.com/