Room-based messaging in Flask

Introduction

Room-based messaging lets users chat in separate groups or rooms. It keeps conversations organized and private.

You want users to join different chat groups like sports or music rooms.

You need to separate messages so only people in the same room see them.

You want to build a live chat app with multiple topics.

You want to manage user access to specific chat areas.

You want to broadcast messages only to a selected group of users.

Syntax

Flask

from flask import Flask, render_template
from flask_socketio import SocketIO, join_room, leave_room, send

app = Flask(__name__)
socketio = SocketIO(app)

@socketio.on('join')
def on_join(data):
    username = data['username']
    room = data['room']
    join_room(room)
    send(f'{username} has entered the room.', to=room)

@socketio.on('leave')
def on_leave(data):
    username = data['username']
    room = data['room']
    leave_room(room)
    send(f'{username} has left the room.', to=room)

@socketio.on('message')
def handle_message(data):
    room = data['room']
    msg = data['msg']
    send(msg, to=room)

Use join_room(room) to add a user to a room.

Use leave_room(room) to remove a user from a room.

Examples

User joins the 'sports' room and a welcome message is sent only to that room.

Flask

join_room('sports')
send('Welcome to sports room!', to='sports')

User leaves the 'music' room and a message is sent to notify others in that room.

Flask

leave_room('music')
send('User left music room', to='music')

Messages are sent only to users in the specified room.

Flask

@socketio.on('message')
def handle_message(data):
    send(data['msg'], to=data['room'])

Sample Program

This Flask app uses Flask-SocketIO to let users join or leave chat rooms and send messages only to those rooms.

Flask

from flask import Flask, render_template
from flask_socketio import SocketIO, join_room, leave_room, send

app = Flask(__name__)
socketio = SocketIO(app)

@app.route('/')
def index():
    return 'Room-based messaging server running.'

@socketio.on('join')
def on_join(data):
    username = data['username']
    room = data['room']
    join_room(room)
    send(f'{username} has entered the room.', to=room)

@socketio.on('leave')
def on_leave(data):
    username = data['username']
    room = data['room']
    leave_room(room)
    send(f'{username} has left the room.', to=room)

@socketio.on('message')
def handle_message(data):
    room = data['room']
    msg = data['msg']
    send(msg, to=room)

if __name__ == '__main__':
    socketio.run(app, debug=True)

Important Notes

Make sure to install flask-socketio with pip install flask-socketio.

Rooms help keep chats organized and private.

Use browser DevTools Network tab to see WebSocket messages during testing.

Summary

Room-based messaging groups users for private chats.

Use join_room and leave_room to manage rooms.

Messages sent to a room reach only users in that room.

Practice

1. What is the main purpose of using rooms in Flask-SocketIO for messaging?

easy

A. To group users so messages can be sent privately to that group

B. To store user passwords securely

C. To create database tables automatically

D. To handle HTTP requests faster

Solution

1. Step 1: Understand the concept of rooms in Flask-SocketIO

   Rooms are used to group users together for messaging purposes.

2. Step 2: Identify the purpose of grouping users

   Grouping users allows sending messages privately to only those in the same room.

3. Final Answer:

   To group users so messages can be sent privately to that group -> Option A

4. Quick Check:

   Rooms = private user groups [OK]

Hint: Rooms group users for private chats [OK]

Common Mistakes:

• Thinking rooms store passwords
• Confusing rooms with database tables
• Assuming rooms speed up HTTP requests

2. Which Flask-SocketIO function is used to add a user to a room?

easy

A. leave_room(room_name)

B. join_room(room_name)

C. send_room(room_name)

D. connect_room(room_name)

Solution

1. Step 1: Recall Flask-SocketIO functions for room management

   The function to add a user to a room is join_room.

2. Step 2: Match function names to their purposes

   leave_room removes a user, send_room is not a valid function, connect_room does not exist.

3. Final Answer:

   join_room(room_name) -> Option B

4. Quick Check:

   join_room = add user to room [OK]

Hint: Use join_room to add users to rooms [OK]

Common Mistakes:

• Using leave_room to add users
• Assuming send_room exists
• Confusing connect_room with join_room

3. Given this code snippet, what will be the output sent to the room 'chatroom1'?

from flask_socketio import send, join_room

@socketio.on('join')
def on_join(data):
    room = data['room']
    join_room(room)
    send('User has entered the room.', room=room)

medium

A. An error occurs because send() cannot specify a room

B. The message is sent to all connected clients regardless of room

C. No message is sent because join_room is missing

D. The message 'User has entered the room.' is sent to all clients in 'chatroom1'

Solution

1. Step 1: Analyze the join_room call

   The user joins the specified room from data['room'], e.g., 'chatroom1'.

2. Step 2: Understand the send function with room parameter

   send() with room=room sends the message only to clients in that room.

3. Final Answer:

   The message 'User has entered the room.' is sent to all clients in 'chatroom1' -> Option D

4. Quick Check:

   send(message, room=room) sends to that room [OK]

Hint: send(message, room=room) targets that room only [OK]

Common Mistakes:

• Thinking send() sends to all clients always
• Believing join_room is not called
• Assuming send() cannot specify a room

4. What is wrong with this code snippet for leaving a room?

@socketio.on('leave')
def on_leave(data):
    room = data['room']
    leave_room()
    send('User has left the room.', room=room)

medium

A. The event name 'leave' is invalid

B. send() cannot send messages after leaving a room

C. leave_room() is called without specifying the room to leave

D. The function on_leave must return a value

Solution

1. Step 1: Check leave_room usage

   leave_room requires the room name as an argument to remove the user from that room.

2. Step 2: Identify missing argument

   In the code, leave_room() is called without any argument, which is incorrect.

3. Final Answer:

   leave_room() is called without specifying the room to leave -> Option C

4. Quick Check:

   leave_room(room) needs room argument [OK]

Hint: Always pass room name to leave_room(room) [OK]

Common Mistakes:

• Calling leave_room without room argument
• Thinking send() cannot be called after leave_room
• Assuming event names must be predefined
• Believing on_leave must return a value

5. You want to send a message only to users in the room 'lobby' except the sender. Which Flask-SocketIO function and parameter combination should you use?

hard

A. send(message, room='lobby', include_self=False)

B. send(message, room='lobby', include_self=True)

C. send(message, broadcast=True)

D. send(message, room='lobby')

Solution

1. Step 1: Understand sending to a room excluding sender

   To send a message to a room but exclude the sender, use include_self=False.

2. Step 2: Match parameters to desired behavior

   send(message, room='lobby', include_self=False) uses send with room='lobby' and include_self=False, which sends to all in 'lobby' except sender.

3. Final Answer:

   send(message, room='lobby', include_self=False) -> Option A

4. Quick Check:

   include_self=False excludes sender [OK]

Hint: Use include_self=False to exclude sender in room message [OK]

Common Mistakes:

• Using include_self=True sends to sender too
• Using broadcast=True sends to all clients
• Omitting include_self sends to sender by default