From 7d662f9d975059744a27eb309fa5c1e0b20e4d1c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Abdussamed=20ULUTA=C5=9E?= Date: Sat, 10 Dec 2022 17:09:42 +0300 Subject: [PATCH] Docs --- Source/Services/Auth.js | 6 ++- docs/protocol.md | 93 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 98 insertions(+), 1 deletion(-) create mode 100644 docs/protocol.md diff --git a/Source/Services/Auth.js b/Source/Services/Auth.js index 49eb97a..4f0097a 100644 --- a/Source/Services/Auth.js +++ b/Source/Services/Auth.js @@ -51,7 +51,11 @@ addService(({ status: 'fail', message: 'ALREADY-REQUESTED' }) - } + }; + end({ + status: 'success', + message: 'REQUESTED' + }) client.peerRequest(pairclient); break; } diff --git a/docs/protocol.md b/docs/protocol.md new file mode 100644 index 0000000..6731334 --- /dev/null +++ b/docs/protocol.md @@ -0,0 +1,93 @@ +# Namespace + +## Auth + +### auth/public: +- Eşleşme gerekmez, herkese açık hale getirir +- İşlem bittiğinde success değeri verirr + +### auth/private +Eşleşme gerekir, biri size mesaj göndermek için onay alması gerekir +Onaylandığında success gönder + +### request/pair +- private bir eşe onay isteği gönderirsiniz, eşe bildirim gider +- Client online değilse fail CLIENT-NOT-FOUND mesajı döner +- Zaten kabul etmişse success ALREADY-PAIRED mesajı döner +- Zaten onay isteği göndermişseniz fail ALREADY-REQUESTED mesajı döner +- Gönderildiğinde success REQUESTED mesajı döner +- Eş isteğe herhangi bir cevap dönerse request/pair veya rejected/pair tetiklenir ve from değerleriyle kim oldukları bildirilir + +### accept/pair +- Uzak eşin onay isteğine onay verirsiniz + +### accept/pair +- Uzak eşin onay isteğine onay verirsiniz + +### reject/pair +- Uzak eşin isteğini reddedersiniz + +### pair/list +- Erişebileceğiniz private eşlerin ve sizinle etkileşime giren eşlerin +listesini verir + +### auth/login +- saQut Account hesabıyla ilgili ön tanımlı hızlı işlem yapar + +### auth/check +- saQut Account hesabıyla ilgili ön tanımlı hızlı işlem yapar + +### auth/logout +- saQut Account hesabıyla ilgili ön tanımlı hızlı işlem yapar + +## Room + +### myroom-info + +Kendinize özel açılan odanın bilgisini verir + +### room-peers + +İçerisinde bulunduğunuz odanın içerisinde bulunan eşlerin listesini verir + +### room-info + +İçerisinde bulunduğunuz odanın bilgisini verir + +### joinedrooms + +Katıldığınız odaların listesini verir + +### closeroom + +Sahibi olduğunuz odayı kapatır + +### create-room + +Yeni bir oda oluşturur + +### joinroom + +Bir odaya katılır veya sahibine katılma isteği gönderirsiniz + +### accept/invite-room + +Gizli bir odaya katılma isteği gödneren kişiyi odaya kabul edersiniz + +### reject/invite-room + +Gizli bir odaya katılma isteği gödneren kişiyi reddedersiniz + +### room/list + +Herkese açık olan tüm odaları listeler + +## Data transfer + +### pack/to + +Diğer eşe bir paket gönderir + +### pack/room + +Bir odaya katılmış tüm üyelere, oda üzerinden bir mesaj gönderir \ No newline at end of file