dnrops
/
slchat
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

[0.1.0] Include recipients in message format

This commit is contained in:
Shial 2017-08-31 14:46:29 +10:00
parent efebdb46e6
commit 4ab243f158
2 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -65,13 +65,19 @@ extension SLClient {
```
Sending message via `sendMessage` protocol method. Provide `SLMessage` object which hold recipients parsed from socket message. This can be chat room ids or simple client ids to which message should be delivered.
Recipients are strings defined by you. Thanks to that you can identify your target clients to which message should be delivered. They can be simple other clients id or room id.
#### SLService
Is very simple in the way it works. First of all what you should know is:
Message sent to clinet looks like:
`M;MESSAGE-OWNER-ID;My message content sent to others`
First character in this case `M` is the type of message. Followed by client id responsible for sending this message and the last part is message content. All parts joined by `;`
`M;MESSAGE-OWNER-ID;{MESSAGE-RECIPIENT-ID, CAN_BE_CHAT_ROOM_ID, CAN_BE_OTHER_CLIENT_ID};My message content sent to others`
First character in this case `M` is the type of message. Followed by client id responsible for sending this message with recipients placed inside `{}` and the last part is message content. All parts joined by `;`
This message model will be delivered to your client application.
``
Status messages (connected or disconnected) are different, they simply have empty recipient closure `{}`. If you receive message:
`C;MESSAGE-OWNER-ID;{};` Simply all clients related with message owner should be notify.
Beside receiving messages, you will send some as well!
Your message should look like:

12
Sources/SLChat/SLMessage.swift
View File

@ -16,6 +16,15 @@ public enum SLMessageCommand: Character {
case readMessage = "R"
case stoppedTyping = "S"
case startedTyping = "T"
func toAll() -> Bool {
switch self {
case .connected, .disconnected:
return true
default:
return false
}
}
}
enum SLMessageError: Int, Error {
@ -47,6 +56,7 @@ public struct SLMessage {
}
func make(_ client: String) -> String {
return [String(describing: command) + client + content].joined(separator: ";")
let recipientString = command.toAll() ? "{}" : "{\(recipients?.joined(separator: ";") ?? "")}"
return [String(describing: command),client,recipientString,content].joined(separator: ";")
}
}