nejma

Nejma

Terinspirasi oleh channels , Nejma memungkinkan Anda mengelola dan mengirim pesan ke grup saluran

Hal -hal yang dapat Anda bangun dengan nejma :

• mengobrol
• pemberitahuan
• menangani pengguna yang terhubung dari beberapa tab)
• Dan lebih banyak ...

Contoh

Lihatlah contoh ini nejma-chat , aplikasi obrolan sederhana yang dibangun menggunakan nejma dan starlette .

Instalasi

$ pip install nejma

Memulai

Berikut adalah contoh menggunakan nejma dengan websockets.

Saluran Impor Pertama dan Channel_Layer dari Nejma

 from nejma import Channel , channel_layer

Buat saluran di Connect

 async def on_connect ( self , websocket , ** kwargs ):
    await super (). on_connect ( websocket , ** kwargs )

    self . channel = Channel ( send = websocket . send )

Tambahkan grup, saluran atau kirim pesan

 async def on_receive ( self , websocket , data ):
    self . channel_layer . add ( group , self . channel )

    await self . channel_layer . group_send ( group , "Welcome !" )

Finnaly, lepaskan saluran setelah koneksi ditutup

 async def on_disconnect ( self , websocket , close_code ):
    self . channel_layer . remove_channel ( self . channel )

Starlette

---

Untuk menggunakan nejma dengan starlette , cukup impor WebSocketendPoint dari Nejma

 from nejma . ext . starlette import WebSocketEndpoint

@ app . websocket_route ( "/ws" )
class Chat ( WebSocketEndpoint ):
    encoding = "json"

    async def on_receive ( self , websocket , data ):
        room_id = data [ 'room_id' ]
        message = data [ 'message' ]
        username = data [ 'username' ]

        if message . strip ():
            group = f"group_ { room_id } "

            self . channel_layer . add ( group , self . channel )

            payload = {
                "username" : username ,
                "message" : message ,
                "room_id" : room_id
            }
            await self . channel_layer . group_send ( group , payload )

Dokumen

Kelas ChannelLayer yang disediakan oleh nejma memperlihatkan metode berikut:

add(group, channel, send=None)

Menambahkan saluran ke grup pemberian.

• Kirim: Metode untuk mengirim pesan ke saluran

 self . channel_layer . add ( group , self . channel , send = websocket . send )

async group_send(group, "Welcome !")

Mengirim pesan ke sekelompok saluran

 await self . channel_layer . group_send ( group , "Welcome !" )

remove(group, channel)

Menghapus saluran dari grup tertentu

 self . channel_layer . remove ( group , self . channel )

remove_channel(channel)

Menghapus saluran dari semua grup

 self . channel_layer . remove_channel ( self . channel )

flush()

Setel ulang semua grup

 self . channel_layer . flush ()