clox

This is how clox works. more…

The server is written in java, but you can have clients in any language you want as long they obey these protocols

connect to the server (the port is 1981, make the ip address configurable since the server can be hosted anywhere)

send a message to the server, the format of the message is

"details:port=" + socket.getLocalPort() + ":sname=" + username + ":saddress=" + socket.getLocalAddress() + "\n";

The “:s” is a delimiter that separates the values.

The server then starts sending you messages.
a. If you are just connecting, the server sends you a list of connected clients. The format is

"clients:clientName1:sclientName2:sclientName3:setc\n"

b. If you already got the list of connected clients, the server keeps updating this list,

so u must continually listen for incoming messages.

c. Also when someone sends you a message, you get the message in this format

"message:from=sender:s" + "to=recipient:s" + "date=longvalueofdate:s" + "msg=message\n";

The ":s" is a delimiter that separates the values.  

The date is a long value(System.getCurrentTimeInMillis()).

d. When someone sends you a file, you get it as a stream of bytes.(a byte can easily be casted to an integer).

The first thing you recieve is a filename in this format

"file:filename:sport:port\n".   

The ":s" is a delimiter that separates the values.  

This means that the server has opened a new port for you to start sending files. The new port is neccessary so that  
    we dont congest the chat port in case the file is large.  

Connect to this port and start reading the bytes sent to you. All you need to do is write these bytes directly to the file  
    you created with filename.

a. When you want to send a message to the another client, use this format

"message:from=sender:s" + "to=recipient:s" + "date=longvalueofdate:s" + "msg=message\n";

The ":s" is a delimiter that separates the values.  

The date is a long value(System.getCurrentTimeInMillis()).

b. When you want to send a file, you do three things

1.  Send the filename of the file you want to send. The format is
    "file:filename=filename:sto=recipient\n".  
    You must include the name of the recipient in this command.  
2. The server then sends you an "ackfile:filename=filename:sport=port\n".   
    This means the filename has been recieved and the server has opened a port for you to start sending the file as bytes.  
    The new port is neccessary for reasons given in 3d. above.  
3.  Send the file itself to server (as bytes). The server reads the bytes send and reconstruct the file on the other end

Also note that the server will read messages from you until it encounters a new line.
So all messages between you and the server must terminate with a newline.
The server already observes this when sending messages to you.
The server doesnt take care of duplicate users. Your client application should take care of that.
Your client should have a log in of some sort such that only truly
registered clients are sent to the server and there are no duplicates.
If you dont want to use a db to keep track of your connected users, check out my other project called Corque.
You can use it track of objects created in your java program.
The server has a gui for management(Starting,stopping and the likes).
I also have a cloxclient repository under this project to give you a feel of what the client should look like.
SUPPORTED PROTOCOLS:
From Server:
clients:csv //see 3a. aboove
message:msgstring //see 3b. above
idle:fromclient, toclient
typing:fromclient, toclient
sms:fromclient, toclient, smsmessage
file:fromclient, toclient, filename
To Server:
String_clientDetails //this must be send at the point of connection. see 2 above
message:string //see 4 above
idle:fromclient,toClient
typing:fromclient,toClient
sms:fromcleint,toClient,smsmessage
file:fromcleint,toClieint,filename

cloxserver

This is the server. This project is all about the server. The client is just a convenient add on

Cloning this repository:

git clone git://gitorious.org/clox/cloxserver.git cloxserver
cd cloxserver

Add this repository as a remote to an existing local repository:

git remote add cloxserver git://gitorious.org/clox/cloxserver.git
git fetch cloxserver
git checkout -b my-local-tracking-branch cloxserver/master_or_other_branch

cloxclient

A sample Java Client for CloxServer

Cloning this repository:

git clone git://gitorious.org/clox/cloxclient.git cloxclient
cd cloxclient

Add this repository as a remote to an existing local repository:

git remote add cloxclient git://gitorious.org/clox/cloxclient.git
git fetch cloxclient
git checkout -b my-local-tracking-branch cloxclient/master_or_other_branch

Activities

Wednesday June 22 2011
- Push
  
  23:09
  
  Akintayo A. Olusegun pushed 3 commits to clox/cloxclient:master. View diff
  
  master changed from 956e9eb to b19166f
Friday May 20 2011
- Push
  
  14:18
  
  Akintayo A. Olusegun pushed 1 commit to clox/cloxserver:master. View diff
  
  master changed from c4f8c33 to 2f4db94
Monday December 06 2010
- Push
  
  12:00
  
  Akintayo A. Olusegun pushed 2 commits to clox/cloxserver:master
  
  master changed from c23900b to c4f8c33
Monday March 15 2010
- Push
  
  09:00
  
  Akintayo A. Olusegun pushed 5a1c81f9 to clox/cloxclient:v1.0
  
  Akintayo A. Olusegun on March 15, 2010 08:59
  
  README
- Commit
  
  08:51
  
  Akintayo A. Olusegun created branch v1.0 on clox/cloxclient
- Commit
  
  08:46
  
  Akintayo A. Olusegun started development of clox/cloxclient
- Repository
  
  08:46
  
  Akintayo A. Olusegun created repository cloxclient in clox
  
  A sample Java Client for CloxServer
- Project
  
  08:45
  
  Akintayo A. Olusegun deleted clox/cloxclient
- Commit
  
  08:36
  
  Akintayo A. Olusegun committed 956e9eb7 to clox
  
  House cleaning
- Commit
  
  08:36
  
  Akintayo A. Olusegun committed 03cdb1b0 to clox
  
  Brings the client window to the front when a new message comes in
- Push
  
  08:26
  
  Akintayo A. Olusegun pushed 2 commits to clox/cloxserver:master
  
  master changed from f11b1e8 to c23900b
Wednesday March 10 2010
- Commit
  
  08:49
  
  Akintayo A. Olusegun committed cf256ea2 to clox
  
  beep when a new message comes in
Tuesday March 09 2010
- Commit
  
  15:24
  
  Akintayo A. Olusegun committed d3bb53db to clox
  
  Chat form should not be resizable
- Commit
  
  13:23
  
  Akintayo A. Olusegun committed 8d2598a3 to clox
  
  removed some System.out.printlns
- Commit
  
  13:13
  
  Akintayo A. Olusegun committed 8a5b2c75 to clox
  
  Notify on successfull transfer of file
- Commit
  
  13:02
  
  Akintayo A. Olusegun committed eaaa868f to clox
  
  We can not line-wrap the recieved and sent messages in the list
- Commit
  
  12:12
  
  Akintayo A. Olusegun committed c5a631a4 to clox
  
  Changed the send textField to a textArea. Also enabled line fold
- Commit
  
  09:07
  
  Akintayo A. Olusegun committed 7cc90461 to clox
  
  We now have the option of either using properties file or
Thursday February 25 2010
- Favorite
  
  10:17
  
  Ugonna Nwakama started watching clox/cloxserver
Monday February 22 2010
- Commit
  
  17:00
  
  Akintayo A. Olusegun committed 62cc2358 to clox
  
  The Last commit didn't solve the problem of top-down vs bottom-up. This commit solved it.
Tuesday February 09 2010
- Commit
  
  14:13
  
  Akintayo A. Olusegun committed 3704d73a to clox
  
  Now we casn display messages top-down instead of bottom-up
- Push
  
  13:33
  
  Akintayo A. Olusegun pushed f11b1e84 to clox/cloxserver:master
  
  Akintayo A. Olusegun on February 09, 2010 09:43
  
  revisited. made changes to the persistence
- Commit
  
  10:17
  
  trinisoftinc committed 630a9b70 to clox
  
  Now we can scroll to the last location in the messages pane
Friday June 26 2009
- Commit
  
  17:58
  
  Akintayo A. Olusegun committed b8a125b5 to clox
  
  House cleaning
Sunday May 17 2009
- Commit
  
  15:06
  
  Akintayo A. Olusegun committed dd35b605 to clox
  
  Now we can transfer files. Also messages scroll from the top
Saturday May 16 2009
- Commit
  
  09:19
  
  Akintayo A. Olusegun committed c5bc8795 to clox
  
  making the paths linux compatible
- Commit
  
  08:41
  
  Akintayo A. Olusegun committed c1a7a121 to clox
  
  Updated the properties file to use my ip address
Friday May 15 2009
- Commit
  
  10:12
  
  Akintayo A. Olusegun committed dcf6d955 to clox
  
  Removed commented code from protocol handler
- Commit
  
  09:49
  
  Akintayo A. Olusegun committed fb811ffd to clox
  
  House Cleaning. Removing debug messages
- Commit
  
  09:39
  
  Akintayo A. Olusegun committed 579e643e to clox
  
  As of this commit, all is well between the client and the server.

Previous 1 2 Next

clox

cloxserver

cloxclient

Activities

Project information

Repository clones

Gitorious