deavmi/birchwood
deavmi/birchwood
1
0
Fork 0
mirror of https://github.com/deavmi/birchwood synced 2024-09-20 15:22:53 +02:00
Code Issues Releases Activity

Client

Browse Source 
- Added missing documentation for `onDirectMessage`, `onChannelMessage`, `onGenericCommand` and `onCommandReply`
This commit is contained in:
Tristan B. Velloza Kildaire 2023-03-16 08:17:56 +02:00
parent 66cd409234
commit 66c3a02d6e
1 changed files with 17 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
source/birchwood/client/client.d
View File

@ -71,23 +71,19 @@ public class Client : Thread
//TODO: Do something here, tare downs //TODO: Do something here, tare downs
} }
// TODO: Investigate
public ConnectionInfo getConnInfo() public ConnectionInfo getConnInfo()
{ {
return connInfo; return connInfo;
} }
/**
* User overridable handler functions below
*/
// TODO: comment
/** /**
* Called on reception of a channel message
* *
* Params: * Params:
* fullMessage = * fullMessage = the channel message in its entirety
* channel = * channel = the channel
* msgBody = * msgBody = the body of the message
*/ */
public void onChannelMessage(Message fullMessage, string channel, string msgBody) public void onChannelMessage(Message fullMessage, string channel, string msgBody)
{ {
@ -95,11 +91,13 @@ public class Client : Thread
logger.log("Channel("~channel~"): "~msgBody); logger.log("Channel("~channel~"): "~msgBody);
} }
// TODO: comment
/** /**
* Called on reception of a direct message
* *
* Params: * Params:
* message = * fullMessage = the direct message in its entirety
* nickname = the sender
* msgBody = the body of the message
*/ */
public void onDirectMessage(Message fullMessage, string nickname, string msgBody) public void onDirectMessage(Message fullMessage, string nickname, string msgBody)
{ {
@ -107,11 +105,11 @@ public class Client : Thread
logger.log("DirectMessage("~nickname~"): "~msgBody); logger.log("DirectMessage("~nickname~"): "~msgBody);
} }
// TODO: comment
/** /**
* Called on generic commands
* *
* Params: * Params:
* commandReply = * commandReply = the generic message
*/ */
public void onGenericCommand(Message message) public void onGenericCommand(Message message)
{ {
@ -119,11 +117,11 @@ public class Client : Thread
logger.log("Generic("~message.getCommand()~", "~message.getFrom()~"): "~message.getParams()); logger.log("Generic("~message.getCommand()~", "~message.getFrom()~"): "~message.getParams());
} }
// TODO: comment
/** /**
* Called on command replies
* *
* Params: * Params:
* commandReply = * commandReply = the command's reply
*/ */
public void onCommandReply(Message commandReply) public void onCommandReply(Message commandReply)
{ {