Serveur

Usage

./myteams_server port

port is the port number on which the server socket listens.

Command Line Interface (CLI) Client

Usage launching client

./myteams_client ip port

ip is the server ip address on which the server socket listens
port is the port number on which the server socket listens

Usage commands in client

/help

show help

/login [“user_name”]

set the user_name used by client

/logout

disconnect the client from the server

/users

get the list of all users that exist on the domain

/user [“user_uuid”]

get information about a user

/send [“user_uuid”] [“message_body”]

send a message to a user

/messages [“user_uuid”]

list all messages exchange with an user

/subscribe [“team_uuid”]

subscribe to the event of a team and its sub directories (enable reception of all events from a team)

/subscribed ?[“team_uuid”]

list all subscribed teams or list all users subscribed to a team

/unsubscribe [“team_uuid”]

unsubscribe from a team

/use ?[“team_uuid”] ?[“channel_uuid”] ?[“thread_uuid”]

use specify a context team/channel/thread

/create [“team_name”] [“team_description”]

create a new team when the context is not defined (/use)

/create [“channel_name”] [“channel_description”]

create a new channel when team_uuid is defined (/use “team_uuid”)

/create [“thread_title”] [“thread_message”]

create a new thread when team_uuid and channel_uuid are defined (/use “team_uuid” “channel_uuid”)

/create [“comment_body”]

create a new reply when team_uuid, channel_uuid and thread_uuid are defined (/use “team_uuid” “channel_uuid” “thread_uuid”)

/list

list all existing teams when the context is not defined (/use)
list all existing channels when team_uuid is defined (/use “team_uuid”)
list all existing threads when team_uuid and channel_uuid are defined (/use “team_uuid” “channel_uuid”)
list all existing replies when team_uuid, channel_uuid and thread_uuid are defined (/use “team_uuid” “channel_uuid” “thread_uuid”)

/info

display currently logged user infos when the context is not defined (/use)
display currently selected team infos when team_uuid is defined (/use “team_uuid”)
display currently selected channel infos when team_uuid and channel_uuid are defined (/use “team_uuid” “channel_uuid”)
display currently selected thread infos when team_uuid, channel_uuid and thread_uuid are defined (/use “team_uuid” “channel_uuid” “thread_uuid”)

List of events sent by the server.

Errors

500 : Default Error - any
400 : Unfound - any
401 : Unauthorized - any
402 : Unknow team team_uuid
403 : Unknow channel - channel_uuid
404 : Unknow thread - thread_uuid
405 : Unknow user - user_uuid
406 : Already exist - any
407 : List error message - any

Success

200 : Default Success - any
201 : List Users Success - any
202 : Login Success - user_uuid|user_name
203 : Logout Success - user_uuid|user_name
204 : List User Success - user_uuid|user_name|user_status
205 : Create Team Success - team_uuid|team_name|team_description
206 : Team Created - team_uuid|team_name|team_description
207 : Create Channel Success - channel_uuid|channel_name|channel_description
208 : Channel Created - channel_uuid|channel_name|channel_description
209 : Create Thread Success - thread_uuid|user_uuid|time|thread_title|thread_body
210 : Thread Created - thread_uuid|user_uuid|time|thread_title|thread_body
211 : Create Comment Success - team_uuid|thread_uuid|user_uuid|time|comment_body
212 : Comment Created - team_uuid|thread_uuid|user_uuid|time|comment_body
214 : Use Success - any
215 : Subscribe Success - user_uuid|team_uuid
216 : Subscribed User Success - user_uuid|team_uuid|team_name|team_description
217 : Subscribed Team Success - team_uuid|user_uuid|user_name|user_status
218 : Unsubscribe Success - user_uuid|team_uuid
219 : Info Specific user Success - user_uuid|user_name|user_status
220 : Message Sent Success - user_uuid|user_name|message_body
221 : List Message Success - user_uuid|user_name|message_body
222 : List Team Success - team_uuid|team_name|team_description
223 : List Channel Success - channel_uuid|channel_name|channel_description
224 : List Thread Success - thread_uuid|user_uuid|time|thread_title|thread_body
225 : List Comment Success - thread_uuid|user_uuid|time|comment_body
226 : Info Team Success - team_uuid|team_name|team_description
227 : Info Channel Success - channel_uuid|channel_name|channel_description
228 : Info Thread Success - thread_uuid|user_uuid|time|thread_title|thread_body
229 : Info User Success - user_uuid|user_name|user_status

Details

The communication protocol we designed to facilitate data exchanges between the server and the CLI interface operates in three distinct parts to be read on the socket. First, we have an integer corresponding to the code of the called event, followed by a second integer representing the size of the string to be read in the third part. The third part thus contains the string itself. This three-part process effectively structures the data exchanged between the server and the CLI interface, facilitating understanding and data processing on the server side.

Write

write(fd, &packet->code, sizeof(int)); // Send the code of the event
write(fd, &packet->len, sizeof(int)); // Send the size of the string
write(fd, packet->data, packet->len); // Send the string

diagram client to server

Read

read(fd, &packet->code, sizeof(int)); // Get the code of the event
read(fd, &packet->len, sizeof(int)); // Get the size of the string
read(fd, packet->data, packet->len); // Get the string

diagram server to client

The string sent contains different information depending on the code of the event. Indeed, each event code is associated with a specific action to be performed on the server side. Thus, the string sent may contain information such as the user's name, the group's name, the message to be sent, etc., depending on the called event. This approach makes communication between the server and the CLI interface more flexible and better suited to the various needs of the application.