Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kharvd/practicechat
Simplistic client-server chat
https://github.com/kharvd/practicechat
Last synced: 16 days ago
JSON representation
Simplistic client-server chat
- Host: GitHub
- URL: https://github.com/kharvd/practicechat
- Owner: kharvd
- Created: 2015-08-11T13:34:54.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2015-08-11T13:37:39.000Z (over 9 years ago)
- Last Synced: 2024-11-09T04:07:42.775Z (about 2 months ago)
- Language: Java
- Homepage:
- Size: 301 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Simplistic chat written in Java
## Building project
Use `package` Maven task for root project. Two standalone jars will be placed in `out/` directory
## DB configuration
This project uses PostgreSQL and [[http://flywaydb.org/ | Flyway]] for database migration.
To run the server you have to supply properties file, containing information about DB connection and TCP port.
Example:
server.port = 1234
db.name = practicechat
db.serverName = localhost
db.username = postgres
db.password = 1234
## Chat protocol description
Chat uses JSON-based protocol for client-server communication.
Every message is a JSON object that contains two fields:
* message_type -- a string that determines the type of the message
* payload -- a JSON object which is specific to the message type
### Client-to-Server messages
#### connect
Tries to login the user with the specified username and password. If the user doesn't exist, registers them.
Username cannot contain spaces. This message must be sent by the client within 1 second after
the socket connection has been established.
Payload example:
{
"username": "john_doe1952",
"password": "qwerty"
}
The server must answer with `login_result` message
#### disconnect
Disconnects currently connected user from the server.
Payload must be `null`.
#### send_message
Sends a message to the specified user or the room (if the username starts with '\#').
Payload example:
{
"username": "NAGibaTOR_40k",
"message": "sup m8"
}
#### get_history
Requests message history with the specified user or the room (if the username starts with '\#'). Gets up to `limit`
messages sent before `timestamp_to`. Limit must be less than 100.
Payload example:
{
"username": "NAGibaTOR_40k",
"limit": 10,
"timestamp_to": 1438182184000
}
#### join_room
Joins a room. Room name must start with a hash sign ('\#'). If the room doesn't exist, it is created and
the current user becomes its administrator. `history_limit` is an optional parameter that
specifies how many recent messages from the last `history_minutes` minutes will be delivered after joining.
Payload example:
{
"name": "#java_devs"
}
#### drop_room
Deletes a room. Current user must be the administrator of the room to be able to drop it
Payload example:
{
"name": "#java_devs"
}
#### leave_room
Current user is removed from the specified room
Payload example:
{
"name": "#dotnet_devs"
}
#### list_users
If the payload is null, asks the server to return the list of all online users. If the payload contains the room name,
server returns the list of all users who joined the room.
Payload example:
{
"room_name": "#java_devs"
}
#### list_rooms
Asks the server to return the list of all existing rooms.
Payload must be `null`.
### Server-to-Client messages
#### connect_result
Sent by the server upon client's `connect` request. `user_exists` is true, if the user was already registered.
`success` is false if the specified user exists and the password is wrong, or if the username contains illegal characters.
Payload example (success):
{
"success": true,
"user_exists": false
}
Payload example (failure):
{
"success": false,
"user_exists": true
}
#### room_joined
Response to `join_room` request. `room_exists` is true, if the user connects to the existing room.
Payload example:
{
"room_name": "#java_devs",
"room_exists": false
}
#### room_dropped
Response to `drop_room` request. `success` is false, if the user is not the administrator of the room.
Payload example:
{
"room_name": "#java_devs",
"success": true
}
#### room_left
Response to `leave_room` request. `success` is false, if the user is not a member of the room.
Payload example:
{
"room_name": "#java_devs",
"success": true
}
#### user_list
Sent by the server as a response to `list_users` command.
Payload example:
{
"room": null,
"users": [
{
"username": "john_doe1952",
"online": true
},
{
"username": "NAGibaTOR_40k",
"online": true
}
]
}
#### room_list
Sent by the server as a response to `list_rooms` command.
Payload example:
{
"rooms": ["#room1", "#room2"]
}
#### message_sent
Sent by a server as an acknowledgement of the message delivery by a user.
Payload example:
{
"username": "NAGibaTOR_40k"
}
#### new_message
Sent by the server when some user sends a message to the current user. Timestamp is in milliseconds.
If `room` parameter is not `null`, the message was sent to a room.
Payload example:
{
"username": "NAGibaTOR_40k",
"room": null,
"online": true,
"message": "sup m8",
"timestamp": 1438182184000
}
#### message_history
Sent by the server as a response to `get_history` command. If the user requested a room's message history,
`destination` always contains the room's name.
Payload example:
{
"messages": [
{
"sender": "NAGibaTOR_40k",
"destination": "john_doe1952",
"message": "sup m8",
"timestamp": 1438182184000
}
]
}