Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wrathchaos/stompclientlib
Simple STOMP Client library, Swift 3 and 4, 4.2, 5 compatible
https://github.com/wrathchaos/stompclientlib
apple client ios ios-app ios-development mobile socketrocket stomp stompclient stompclientlib swift swift5 websocket xcode
Last synced: 5 days ago
JSON representation
Simple STOMP Client library, Swift 3 and 4, 4.2, 5 compatible
- Host: GitHub
- URL: https://github.com/wrathchaos/stompclientlib
- Owner: WrathChaos
- License: mit
- Created: 2017-07-07T10:02:05.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-31T12:32:47.000Z (3 months ago)
- Last Synced: 2024-10-25T16:59:12.263Z (11 days ago)
- Topics: apple, client, ios, ios-app, ios-development, mobile, socketrocket, stomp, stompclient, stompclientlib, swift, swift5, websocket, xcode
- Language: Swift
- Homepage: https://www.freakycoder.com
- Size: 41.3 MB
- Stars: 153
- Watchers: 9
- Forks: 81
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# StompClientLib
## Introduction
StompClientLib is a stomp client in Swift. It uses Facebook's [ SocketRocket ](https://github.com/facebook/SocketRocket) as a websocket dependency. SocketRocket is written in Objective-C but StompClientLib's STOMP part is written in Swift and its usage is Swift. You can use this library in your Swift 5+, 4+ and 3+ projects.
## Supported Stomp Versions
Stomp version
- **1.1**
- **1.2**
- Might **not** be worked with 1.0 (Never tested)
## Example
To run the example project, clone the repo, and run `pod install` from the Example directory first.
## Requirements
- iOS 8.0+
- XCode 8.1, 8.2, 8.3
- XCode 9.0+
- **XCode 10.0 +**
- **XCode 12.1 +**
- Swift 3.0, 3.1, 3.2
- **Swift 4.0, Swift 4.1, Swift 4.2, Swift 5.0**
## Installation
StompClientLib is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:
#### Cocoapods
```ruby
pod "StompClientLib"
```
#### Carthage
```ruby
github "WrathChaos/StompClientLib"
```
## Usage
```swift
import StompClientLib
```
Once imported, you can open a connection to your WebSocket server.
```swift
var socketClient = StompClientLib()
let url = NSURL(string: "your-socket-url-is-here")!
socketClient.openSocketWithURLRequest(request: NSURLRequest(url: url as URL) , delegate: self)
```
After you are connected, there are some delegate methods that you need to implement.
# StompClientLibDelegate
## stompClientDidConnect
```swift
func stompClientDidConnect(client: StompClientLib!) {
print("Socket is connected")
// Stomp subscribe will be here!
socketClient.subscribe(destination: topic)
// Note : topic needs to be a String object
}
```
## stompClientDidDisconnect
```swift
func stompClientDidDisconnect(client: StompClientLib!) {
print("Socket is Disconnected")
}
```
## didReceiveMessageWithJSONBody ( Message Received via STOMP )
Your json message will be converted to JSON Body as AnyObject and you will receive your message in this function
```swift
func stompClient(client: StompClientLib!, didReceiveMessageWithJSONBody jsonBody: AnyObject?, akaStringBody stringBody: String?, withHeader header: [String : String]?, withDestination destination: String) {
print("Destination : \(destination)")
print("JSON Body : \(String(describing: jsonBody))")
print("String Body : \(stringBody ?? "nil")")
}
```
## didReceiveMessageWithJSONBody ( Message Received via STOMP as String )
Your json message will be converted to JSON Body as AnyObject and you will receive your message in this function
```swift
func stompClientJSONBody(client: StompClientLib!, didReceiveMessageWithJSONBody jsonBody: String?, withHeader header: [String : String]?, withDestination destination: String) {
print("DESTINATION : \(destination)")
print("String JSON BODY : \(String(describing: jsonBody))")
}
```
## serverDidSendReceipt
If you will use STOMP for in-app purchase, you might need to use this function to get receipt
```swift
func serverDidSendReceipt(client: StompClientLib!, withReceiptId receiptId: String) {
print("Receipt : \(receiptId)")
}
```
## serverDidSendError
Your error message will be received in this function
```swift
func serverDidSendError(client: StompClientLib!, withErrorMessage description: String, detailedErrorMessage message: String?) {
print("Error Send : \(String(describing: message))")
}
```
## serverDidSendPing
If you need to control your server's ping, here is your part
```swift
func serverDidSendPing() {
print("Server ping")
}
```
## How to subscribe and unsubscribe
There are functions for subscribing and unsubscribing.
Note : You should handle your subscribe and unsubscribe methods !
Suggestion : Subscribe to your topic in "stompClientDidConnect" function and unsubcribe to your topic in stompClientWillDisconnect method.
## Subscribe
```swift
socketClient.subscribe(destination: topic)
// Note : topic needs to be a String object
```
## Unsubscribe
```swift
socketClient.unsubscribe(destination: topic)
```
Important : You have to send your destination for both subscribe or unsubscribe!
## Unsubsribe with header
```swift
let destination = "/topic/your_topic"
let ack = destination
let id = destination
let header = ["destination": destination, "ack": ack, "id": id]
// subscribe
socketClient?.subscribeWithHeader(destination: destination, withHeader: header)
// unsubscribe
socketClient?.unsubscribe(destination: subsId)
```
## Auto Reconnect with a given time
You can use this feature if you need to auto reconnect with a specific time or it will just try to reconnect every second.
```swift
// Reconnect after 4 sec
socketClient.reconnect(request: NSURLRequest(url: url as URL) , delegate: self as StompClientLibDelegate, time: 4.0)
```
## Auto Disconnect with a given time
```swift
// Auto Disconnect after 3 sec
socketClient.autoDisconnect(time: 3)
```
## Login Passcode Implementation
This is just an example. You need to convert to your implementation.
[#42](https://github.com/WrathChaos/StompClientLib/issues/42)
```swift
let connectFrame = "CONNECT\n login:admin\n passcode:password\n\n\n\0"
socket.write(string: connectFrame)
```
## Future Enhancements
- [x] ~~Complete a working Example~~
- [x] ~~Add Carthage installation option~~
- [x] ~~Add Swift Package Manager installation option~~
- [x] ~~XCode 9 compatibility~~
- [x] ~~Swift 4 compatibility and tests~~
- [ ] [Apple's New Socket for iOS 13](https://developer.apple.com/documentation/network/nwprotocolwebsocket) Implementation from stratch
# Changelog
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/1.3.8...HEAD)
**Implemented enhancements:**
- SUBSCRIBE and UNSUBSCRIBE Delegate is missing [\#16](https://github.com/WrathChaos/StompClientLib/issues/16)
**Closed issues:**
- Error Domain=SRWebSocketErrorDomain Code=2132 "received bad response code from server 403" [\#86](https://github.com/WrathChaos/StompClientLib/issues/86)
- the delegate should be weak [\#83](https://github.com/WrathChaos/StompClientLib/issues/83)
## [1.3.8](https://github.com/WrathChaos/StompClientLib/tree/1.3.8) (2020-03-08)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/1.3.7...1.3.8)
**Implemented enhancements:**
- Socket stopped working once I moved from ws//: to wss//: [\#67](https://github.com/WrathChaos/StompClientLib/issues/67)
- Self sign certificate, 400 error [\#66](https://github.com/WrathChaos/StompClientLib/issues/66)
- How to increase output buffer [\#37](https://github.com/WrathChaos/StompClientLib/issues/37)
**Fixed bugs:**
- unable to install [\#78](https://github.com/WrathChaos/StompClientLib/issues/78)
- Number of received messages is limited [\#76](https://github.com/WrathChaos/StompClientLib/issues/76)
**Closed issues:**
- Can't find header in initial call [\#81](https://github.com/WrathChaos/StompClientLib/issues/81)
- Can't connect to websocket : received bad response code from server 422 [\#80](https://github.com/WrathChaos/StompClientLib/issues/80)
- I just closed the issue because of the stale & reproducible problem [\#79](https://github.com/WrathChaos/StompClientLib/issues/79)
- unable to install [\#77](https://github.com/WrathChaos/StompClientLib/issues/77)
- stompClientDidConnect not called with Spring boot [\#73](https://github.com/WrathChaos/StompClientLib/issues/73)
- Issue with Cookies in header [\#71](https://github.com/WrathChaos/StompClientLib/issues/71)
- Can't see any Websocket traffic in Charles Proxy [\#70](https://github.com/WrathChaos/StompClientLib/issues/70)
- End of stream error [\#69](https://github.com/WrathChaos/StompClientLib/issues/69)
- Cannot connect with Stomp Websocket when custom header [\#64](https://github.com/WrathChaos/StompClientLib/issues/64)
- Can't connect Socket with Spring Boot 2.x.x [\#63](https://github.com/WrathChaos/StompClientLib/issues/63)
- Multiple clients [\#48](https://github.com/WrathChaos/StompClientLib/issues/48)
- IPV6 [\#38](https://github.com/WrathChaos/StompClientLib/issues/38)
**Merged pull requests:**
- fix delegate [\#84](https://github.com/WrathChaos/StompClientLib/pull/84) ([soledue](https://github.com/soledue))
- Fix typo [\#74](https://github.com/WrathChaos/StompClientLib/pull/74) ([wanbok](https://github.com/wanbok))
## [1.3.7](https://github.com/WrathChaos/StompClientLib/tree/1.3.7) (2019-08-26)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/1.3.6...1.3.7)
**Closed issues:**
- The problem when receiving the messages from the Spring boot. [\#68](https://github.com/WrathChaos/StompClientLib/issues/68)
## [1.3.6](https://github.com/WrathChaos/StompClientLib/tree/1.3.6) (2019-08-06)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/1.3.5...1.3.6)
**Implemented enhancements:**
- Refactor code and fix support spring 2.1.x [\#65](https://github.com/WrathChaos/StompClientLib/pull/65) ([baonguyena1](https://github.com/baonguyena1))
**Fixed bugs:**
- v1.3.4 replaced my custom header in open socket? [\#58](https://github.com/WrathChaos/StompClientLib/issues/58)
**Closed issues:**
- Json error: The data couldn’t be read because it isn’t in the correct format. [\#60](https://github.com/WrathChaos/StompClientLib/issues/60)
**Merged pull requests:**
- Fixed ACK id header and added new ACK type [\#62](https://github.com/WrathChaos/StompClientLib/pull/62) ([rodmytro](https://github.com/rodmytro))
## [1.3.5](https://github.com/WrathChaos/StompClientLib/tree/1.3.5) (2019-07-25)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/1.3.4...1.3.5)
**Fixed bugs:**
- StompClientDidConnect not called on a fresh project [\#51](https://github.com/WrathChaos/StompClientLib/issues/51)
**Closed issues:**
- SendJSONForDict error [\#57](https://github.com/WrathChaos/StompClientLib/issues/57)
- Can't connect to websocket with authorization header [\#39](https://github.com/WrathChaos/StompClientLib/issues/39)
**Merged pull requests:**
- \#58 fix open socket with custom header issue [\#59](https://github.com/WrathChaos/StompClientLib/pull/59) ([marain87](https://github.com/marain87))
## [1.3.4](https://github.com/WrathChaos/StompClientLib/tree/1.3.4) (2019-07-19)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/1.3.3...1.3.4)
## [1.3.3](https://github.com/WrathChaos/StompClientLib/tree/1.3.3) (2019-07-18)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/1.3.2...1.3.3)
**Closed issues:**
- Missing merge [\#55](https://github.com/WrathChaos/StompClientLib/issues/55)
- Data garbled problem,help [\#41](https://github.com/WrathChaos/StompClientLib/issues/41)
**Merged pull requests:**
- String body parameter and ':'-in-header-value fix [\#56](https://github.com/WrathChaos/StompClientLib/pull/56) ([Erhannis](https://github.com/Erhannis))
## [1.3.2](https://github.com/WrathChaos/StompClientLib/tree/1.3.2) (2019-07-10)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/1.3.1...1.3.2)
**Implemented enhancements:**
- stompClientWillDisconnect missing [\#44](https://github.com/WrathChaos/StompClientLib/issues/44)
## [1.3.1](https://github.com/WrathChaos/StompClientLib/tree/1.3.1) (2019-06-14)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/1.3.0...1.3.1)
**Closed issues:**
- Can I subscribe to multiple topics with one stomp client? [\#47](https://github.com/WrathChaos/StompClientLib/issues/47)
- After subscribing to a topic, how to handle messages from server side? [\#46](https://github.com/WrathChaos/StompClientLib/issues/46)
- socket?.readyState is .OPEN and it never goes to my own "stompClientDidDisconnect" method [\#45](https://github.com/WrathChaos/StompClientLib/issues/45)
- Didconnect function cannot be callback after successful connection [\#43](https://github.com/WrathChaos/StompClientLib/issues/43)
- Login, passcode [\#42](https://github.com/WrathChaos/StompClientLib/issues/42)
- App goes in background lock the kepad the socket disconnected [\#40](https://github.com/WrathChaos/StompClientLib/issues/40)
- stompClientDidConnect not called with Spring boot [\#35](https://github.com/WrathChaos/StompClientLib/issues/35)
- Delegate StompClientDidConnect not called after connect-\>disconnect-\>connect [\#15](https://github.com/WrathChaos/StompClientLib/issues/15)
## [1.3.0](https://github.com/WrathChaos/StompClientLib/tree/1.3.0) (2019-04-30)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/1.2.7...1.3.0)
**Implemented enhancements:**
- invalidate reconnect [\#36](https://github.com/WrathChaos/StompClientLib/issues/36)
**Closed issues:**
- Should add Carthage [\#33](https://github.com/WrathChaos/StompClientLib/issues/33)
- Invalid Sec-WebSocket-Accept response [\#32](https://github.com/WrathChaos/StompClientLib/issues/32)
- Socket is disconnected with 1007 code as soon as it connected [\#31](https://github.com/WrathChaos/StompClientLib/issues/31)
- enable Assert \(self.readyState != SR_CONNECTING\) [\#24](https://github.com/WrathChaos/StompClientLib/issues/24)
## [1.2.7](https://github.com/WrathChaos/StompClientLib/tree/1.2.7) (2018-10-23)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/1.2.6...1.2.7)
## [1.2.6](https://github.com/WrathChaos/StompClientLib/tree/1.2.6) (2018-10-23)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/1.2.5...1.2.6)
**Fixed bugs:**
- Error when connected to socket [\#23](https://github.com/WrathChaos/StompClientLib/issues/23)
**Closed issues:**
- Auto disconnects [\#11](https://github.com/WrathChaos/StompClientLib/issues/11)
## [1.2.5](https://github.com/WrathChaos/StompClientLib/tree/1.2.5) (2018-10-22)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/1.2.4...1.2.5)
**Closed issues:**
- Value for "message-id" is always "1" [\#22](https://github.com/WrathChaos/StompClientLib/issues/22)
- Multiple subscription to topics [\#20](https://github.com/WrathChaos/StompClientLib/issues/20)
- I think there is a memory leak for the delegate [\#19](https://github.com/WrathChaos/StompClientLib/issues/19)
- Getting error when framwork is installed in Objective c project [\#9](https://github.com/WrathChaos/StompClientLib/issues/9)
## [1.2.4](https://github.com/WrathChaos/StompClientLib/tree/1.2.4) (2018-10-17)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/1.2.3...1.2.4)
**Closed issues:**
- didCloseWithCode 1000, reason: nil [\#21](https://github.com/WrathChaos/StompClientLib/issues/21)
## [1.2.3](https://github.com/WrathChaos/StompClientLib/tree/1.2.3) (2018-10-17)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/1.2.2...1.2.3)
**Implemented enhancements:**
- How to receive heartbeat? [\#18](https://github.com/WrathChaos/StompClientLib/issues/18)
**Closed issues:**
- Socket is not getting connected [\#30](https://github.com/WrathChaos/StompClientLib/issues/30)
- didCloseWithCode 1002 [\#29](https://github.com/WrathChaos/StompClientLib/issues/29)
- No response [\#27](https://github.com/WrathChaos/StompClientLib/issues/27)
- didCloseWithCode 1001, reason: "Stream end encountered" [\#26](https://github.com/WrathChaos/StompClientLib/issues/26)
- Stream end encountered [\#17](https://github.com/WrathChaos/StompClientLib/issues/17)
- unsubscribe socketclient [\#14](https://github.com/WrathChaos/StompClientLib/issues/14)
- It not able to connect web socket. [\#13](https://github.com/WrathChaos/StompClientLib/issues/13)
- One of the delegate method is not being called. [\#12](https://github.com/WrathChaos/StompClientLib/issues/12)
- StompClient Disconnection. [\#10](https://github.com/WrathChaos/StompClientLib/issues/10)
- Unable to find a specification for 'StompClientLib' [\#8](https://github.com/WrathChaos/StompClientLib/issues/8)
## [1.2.2](https://github.com/WrathChaos/StompClientLib/tree/1.2.2) (2017-11-03)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/1.2.1...1.2.2)
## [1.2.1](https://github.com/WrathChaos/StompClientLib/tree/1.2.1) (2017-10-31)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/1.2.0...1.2.1)
## [1.2.0](https://github.com/WrathChaos/StompClientLib/tree/1.2.0) (2017-10-29)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/1.1.7...1.2.0)
**Closed issues:**
- Let client decide what to do with stomp frame body [\#4](https://github.com/WrathChaos/StompClientLib/issues/4)
- Send message support [\#3](https://github.com/WrathChaos/StompClientLib/issues/3)
- Error when calling delegate [\#1](https://github.com/WrathChaos/StompClientLib/issues/1)
## [1.1.7](https://github.com/WrathChaos/StompClientLib/tree/1.1.7) (2017-10-02)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/1.1.6...1.1.7)
## [1.1.6](https://github.com/WrathChaos/StompClientLib/tree/1.1.6) (2017-08-08)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/0.1.5...1.1.6)
## [0.1.5](https://github.com/WrathChaos/StompClientLib/tree/0.1.5) (2017-07-10)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/0.1.4...0.1.5)
## [0.1.4](https://github.com/WrathChaos/StompClientLib/tree/0.1.4) (2017-07-10)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/0.1.3...0.1.4)
## [0.1.3](https://github.com/WrathChaos/StompClientLib/tree/0.1.3) (2017-07-10)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/0.1.2...0.1.3)
## [0.1.2](https://github.com/WrathChaos/StompClientLib/tree/0.1.2) (2017-07-08)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/0.1.1...0.1.2)
## [0.1.1](https://github.com/WrathChaos/StompClientLib/tree/0.1.1) (2017-07-08)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/0.1.0...0.1.1)
## [0.1.0](https://github.com/WrathChaos/StompClientLib/tree/0.1.0) (2017-07-08)
[Full Changelog](https://github.com/WrathChaos/StompClientLib/compare/cbd49d3cad9a33ae96ff1708f7e0d3e975455325...0.1.0)
\* _This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)_
## Author
FreakyCoder, [email protected]
## License
StompClientLib is available under the MIT license. See the LICENSE file for more info.