WatsonWebsocket

Watson Websocket

Watsonwebsocket - самый простой и быстрый способ создания клиентских и серверных приложений, которые полагаются на обмен сообщениями с помощью веб -окетов. Его. Действительно. Легкий.

Спасибо и признательность

Большое спасибо и большое благодарность тем, кто тратит время на то, чтобы сделать эту библиотеку лучше!

@Bryancrotaz @foddermk @caozero @danatobob @data33 @ak5nowman @jjxtra @martyix @rajeshdua123 @tersers @mackey-255 @krookoo1 @joreg @ilsnk @xbarra @jlopvet @marco-manfroni-manfroni-manfroni- @exergist @ebarale99 @warstekhun @rubidium37 @codengine

Тестирование приложения

Тестовый проект как для клиента ( TestClient ), так и для сервера ( TestServer ), который поможет вам понять и использовать библиотеку классов.

Тестовый проект, который порождает сервер и клиента и обменивается сообщениями здесь: https://github.com/jchristn/watsonwebsockettestest

Поддерживаемые операционные системы

Watsonwebsocket в настоящее время полагается на поддержку WebSocket, присутствующую в базовой операционной системе. Windows 7 не поддерживает веб -питания.

Сбл

SSL поддерживается в Watsonwebsocket. Конструкторы для WatsonWsServer и WatsonWsClient принимают bool указывающий, должен ли SSL быть включен. Поскольку WebSockets и как побочный продукт WatsonWebSocket, используйте HTTPS, они полагаются на сертификаты в хранилище сертификации вашей операционной системы. Испытательный сертификат предоставляется как в проектах TestClient , так и TestServer , которые можно использовать для целей тестирования. Они не должны использоваться в производстве.

Для получения дополнительной информации об использовании сертификатов SSL, пожалуйста, обратитесь к вики.

Новое в v4.0.x

• Нарушение изменений
• Клиенты в настоящее время определены Guid в ClientMetadata
• ListClients теперь возвращает полную ClientMetadata
• Send* методы теперь возьмите guid , а не IpPort
• Добавить таргетинг для .NET 7.0 и .NET Framework 4.8
• Исправление для Blazor Wasm, спасибо @ebarale99
• Исправление для неверных контрольных персонажей, спасибо @warstekhun

Пример сервера

 using WatsonWebsocket ;

WatsonWsServer server = new WatsonWsServer ( "[ip]" , port , true | false ) ;
server . ClientConnected += ClientConnected ;
server . ClientDisconnected += ClientDisconnected ;
server . MessageReceived += MessageReceived ; 
server . Start ( ) ;

static void ClientConnected ( object sender , ConnectionEventArgs args ) 
{
    Console . WriteLine ( "Client connected: " + args . Client . ToString ( ) ) ;
}

static void ClientDisconnected ( object sender , DisconnectionEventArgs args ) 
{
    Console . WriteLine ( "Client disconnected: " + args . Client . ToString ( ) ) ;
}

static void MessageReceived ( object sender , MessageReceivedEventArgs args ) 
{ 
    Console . WriteLine ( "Message received from " + args . Client . ToString ( ) + ": " + Encoding . UTF8 . GetString ( args . Data ) ) ;
} 

Пример клиента

 using WatsonWebsocket ;

WatsonWsClient client = new WatsonWsClient ( "[server ip]" , [ server port ] , true | false ) ;
client . ServerConnected += ServerConnected ;
client . ServerDisconnected += ServerDisconnected ;
client . MessageReceived += MessageReceived ; 
client . Start ( ) ; 

static void MessageReceived ( object sender , MessageReceivedEventArgs args ) 
{
    Console . WriteLine ( "Message from server: " + Encoding . UTF8 . GetString ( args . Data ) ) ;
}

static void ServerConnected ( object sender , EventArgs args ) 
{
    Console . WriteLine ( "Server connected" ) ;
}

static void ServerDisconnected ( object sender , EventArgs args ) 
{
    Console . WriteLine ( "Server disconnected" ) ;
} 

Пример клиента с использованием браузера

 server = new WatsonWsServer ( "http://localhost:9000/" ) ;
server . Start ( ) ; 

 let socket = new WebSocket ( "ws://localhost:9000/test/" ) ;
socket . onopen = function ( ) { console . log ( "success" ) ; } ;
socket . onmessage = function ( msg ) { console . log ( msg . data ) ; } ;
socket . onclose = function ( ) { console . log ( "closed" ) ; } ;
// wait a moment
socket . send ( "Hello, world!" ) ; 

Доступ из -за пределов местного хозяйства

Когда вы настраиваете WatsonWebSocket для прослушивания на 127.0.0.1 или localhost , он будет отвечать только на запросы, полученные из локальной машины.

Чтобы настроить доступ из других узлов за пределами localhost , используйте следующее:

• Укажите точное имя хоста DNS, на котором должен прослушать WatsonWebSocket в конструкторе сервера. Заголовок хоста в входящих HTTP -запросах должен соответствовать этому значению (это ограничение операционной системы)
• Если вы хотите прослушать более одного имени хоста или IP -адреса, используйте * или + . Вы должны:
  • Запустите Watsonwebsocket в качестве администратора для работы (это ограничение операционной системы)
  • Используйте конструктор сервера, который принимает различные значения имени хоста и порта (не конструктор на основе URI)
• Если вы хотите использовать номер порта менее 1024, вы должны запустить WatsonWebSocket в качестве администратора (это ограничение операционной системы)
• Если вы прослушиваете IP -адрес интерфейса, отличный от 127.0.0.1 , вам может потребоваться запустить в качестве администратора (это зависит от операционной системы)
• Откройте порт на вашем брандмауэре, чтобы разрешить трафик на порту TCP, на котором Watsonwebsocket слушает
• Возможно, вам придется добавить URL ACL, т.е. привязки URL -адреса, в операционной системе, используя команду netsh :
  • Проверьте наличие существующих привязков, используя netsh http show urlacl
  • Добавить привязку с помощью netsh http add urlacl url=http://[hostname]:[port]/ user=everyone listen=yes
  • Где hostname и port - это значения, которые вы используете в конструкторе
• Если вы используете SSL, вам нужно будет установить сертификат в магазине сертификатов и получить отпечаток
  • Обратитесь к https://github.com/jchristn/watsonwebserver/wiki/using-ssl-on-windows для получения дополнительной информации или, если вы используете SSL
• Если у вас все еще есть проблемы, пожалуйста, не стесняйтесь подавать здесь проблему, и я сделаю все возможное, чтобы помочь и обновить документацию.

История версий

Пожалуйста, обратитесь к Changelog.md для получения подробной информации.