Initial QSfera import
This commit is contained in:
Курнат Андрей
@@ -0,0 +1,2 @@
|
||||
.idea
|
||||
.vscode
|
||||
+15
@@ -0,0 +1,15 @@
|
||||
linters:
|
||||
enable-all: true
|
||||
disable:
|
||||
- gofmt
|
||||
- gofumpt
|
||||
- goimports
|
||||
- golint # deprecated
|
||||
- interfacer # deprecated
|
||||
- maligned # deprecated
|
||||
- scopelint # deprecated
|
||||
- varnamelen
|
||||
|
||||
linters-settings:
|
||||
govet:
|
||||
enable-all: true
|
||||
+80
@@ -0,0 +1,80 @@
|
||||
# Contributing guidelines
|
||||
|
||||
Looking to contribute something to this project? Here's how you can help:
|
||||
|
||||
Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.
|
||||
|
||||
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.
|
||||
|
||||
We also have a [code of conduct](https://ernest.io/conduct).
|
||||
|
||||
## Using the issue tracker
|
||||
|
||||
The issue tracker is the preferred channel for [bug reports](#bug-reports), [features requests](#feature-requests) and [submitting pull requests](#pull-requests), but please respect the following restrictions:
|
||||
|
||||
* Please **do not** use the issue tracker for personal support requests.
|
||||
|
||||
* Please **do not** derail issues. Keep the discussion on topic and
|
||||
respect the opinions of others.
|
||||
|
||||
<a name="bugs"></a>
|
||||
## Bug reports
|
||||
|
||||
A bug is a _demonstrable problem_ that is caused by the code in the repository.
|
||||
Good bug reports are extremely helpful - thank you!
|
||||
|
||||
Guidelines for bug reports:
|
||||
|
||||
1. **Use the GitHub issue search** — check if the issue has already been
|
||||
reported.
|
||||
|
||||
2. **Check if the issue has been fixed** — try to reproduce it using the
|
||||
latest `master` or `develop` branch in the repository.
|
||||
|
||||
3. **Isolate the problem** — create a reduced test case and a live example.
|
||||
|
||||
A good bug report shouldn't leave others needing to chase you up for more
|
||||
information. Please try to be as detailed as possible in your report. What is
|
||||
your environment? What steps will reproduce the issue? Which environment experience the problem? What would you expect to be the outcome? All these
|
||||
details will help people to fix any potential bugs.
|
||||
|
||||
Example:
|
||||
|
||||
> Short and descriptive example bug report title
|
||||
>
|
||||
> A summary of the issue and the environment in which it occurs. If
|
||||
> suitable, include the steps required to reproduce the bug.
|
||||
>
|
||||
> 1. This is the first step
|
||||
> 2. This is the second step
|
||||
> 3. Further steps, etc.
|
||||
>
|
||||
> `<url>` - a link to the reduced test case
|
||||
>
|
||||
> Any other information you want to share that is relevant to the issue being
|
||||
> reported. This might include the lines of code that you have identified as
|
||||
> causing the bug, and potential solutions (and your opinions on their
|
||||
> merits).
|
||||
|
||||
<a name="features"></a>
|
||||
## Feature requests
|
||||
|
||||
Feature requests are welcome. But take a moment to find out whether your idea
|
||||
fits with the scope and aims of the project. It's up to *you* to make a strong
|
||||
case to convince the project's developers of the merits of this feature. Please
|
||||
provide as much detail and context as possible.
|
||||
|
||||
<a name="pull-requests"></a>
|
||||
## Pull requests
|
||||
|
||||
Good pull requests - patches, improvements, new features - are a fantastic
|
||||
help. They should remain focused in scope and avoid containing unrelated
|
||||
commits.
|
||||
|
||||
[**Please ask first**](https://ernest.io/community) before embarking on any significant pull request (e.g.
|
||||
implementing features, refactoring code, porting to a different language),
|
||||
otherwise you risk spending a lot of time working on something that the
|
||||
project's developers might not want to merge into the project.
|
||||
|
||||
Please adhere to the coding conventions used throughout a project (indentation,
|
||||
accurate comments, etc.) and any other requirements (such as test coverage).
|
||||
+373
@@ -0,0 +1,373 @@
|
||||
Mozilla Public License Version 2.0
|
||||
==================================
|
||||
|
||||
1. Definitions
|
||||
--------------
|
||||
|
||||
1.1. "Contributor"
|
||||
means each individual or legal entity that creates, contributes to
|
||||
the creation of, or owns Covered Software.
|
||||
|
||||
1.2. "Contributor Version"
|
||||
means the combination of the Contributions of others (if any) used
|
||||
by a Contributor and that particular Contributor's Contribution.
|
||||
|
||||
1.3. "Contribution"
|
||||
means Covered Software of a particular Contributor.
|
||||
|
||||
1.4. "Covered Software"
|
||||
means Source Code Form to which the initial Contributor has attached
|
||||
the notice in Exhibit A, the Executable Form of such Source Code
|
||||
Form, and Modifications of such Source Code Form, in each case
|
||||
including portions thereof.
|
||||
|
||||
1.5. "Incompatible With Secondary Licenses"
|
||||
means
|
||||
|
||||
(a) that the initial Contributor has attached the notice described
|
||||
in Exhibit B to the Covered Software; or
|
||||
|
||||
(b) that the Covered Software was made available under the terms of
|
||||
version 1.1 or earlier of the License, but not also under the
|
||||
terms of a Secondary License.
|
||||
|
||||
1.6. "Executable Form"
|
||||
means any form of the work other than Source Code Form.
|
||||
|
||||
1.7. "Larger Work"
|
||||
means a work that combines Covered Software with other material, in
|
||||
a separate file or files, that is not Covered Software.
|
||||
|
||||
1.8. "License"
|
||||
means this document.
|
||||
|
||||
1.9. "Licensable"
|
||||
means having the right to grant, to the maximum extent possible,
|
||||
whether at the time of the initial grant or subsequently, any and
|
||||
all of the rights conveyed by this License.
|
||||
|
||||
1.10. "Modifications"
|
||||
means any of the following:
|
||||
|
||||
(a) any file in Source Code Form that results from an addition to,
|
||||
deletion from, or modification of the contents of Covered
|
||||
Software; or
|
||||
|
||||
(b) any new file in Source Code Form that contains any Covered
|
||||
Software.
|
||||
|
||||
1.11. "Patent Claims" of a Contributor
|
||||
means any patent claim(s), including without limitation, method,
|
||||
process, and apparatus claims, in any patent Licensable by such
|
||||
Contributor that would be infringed, but for the grant of the
|
||||
License, by the making, using, selling, offering for sale, having
|
||||
made, import, or transfer of either its Contributions or its
|
||||
Contributor Version.
|
||||
|
||||
1.12. "Secondary License"
|
||||
means either the GNU General Public License, Version 2.0, the GNU
|
||||
Lesser General Public License, Version 2.1, the GNU Affero General
|
||||
Public License, Version 3.0, or any later versions of those
|
||||
licenses.
|
||||
|
||||
1.13. "Source Code Form"
|
||||
means the form of the work preferred for making modifications.
|
||||
|
||||
1.14. "You" (or "Your")
|
||||
means an individual or a legal entity exercising rights under this
|
||||
License. For legal entities, "You" includes any entity that
|
||||
controls, is controlled by, or is under common control with You. For
|
||||
purposes of this definition, "control" means (a) the power, direct
|
||||
or indirect, to cause the direction or management of such entity,
|
||||
whether by contract or otherwise, or (b) ownership of more than
|
||||
fifty percent (50%) of the outstanding shares or beneficial
|
||||
ownership of such entity.
|
||||
|
||||
2. License Grants and Conditions
|
||||
--------------------------------
|
||||
|
||||
2.1. Grants
|
||||
|
||||
Each Contributor hereby grants You a world-wide, royalty-free,
|
||||
non-exclusive license:
|
||||
|
||||
(a) under intellectual property rights (other than patent or trademark)
|
||||
Licensable by such Contributor to use, reproduce, make available,
|
||||
modify, display, perform, distribute, and otherwise exploit its
|
||||
Contributions, either on an unmodified basis, with Modifications, or
|
||||
as part of a Larger Work; and
|
||||
|
||||
(b) under Patent Claims of such Contributor to make, use, sell, offer
|
||||
for sale, have made, import, and otherwise transfer either its
|
||||
Contributions or its Contributor Version.
|
||||
|
||||
2.2. Effective Date
|
||||
|
||||
The licenses granted in Section 2.1 with respect to any Contribution
|
||||
become effective for each Contribution on the date the Contributor first
|
||||
distributes such Contribution.
|
||||
|
||||
2.3. Limitations on Grant Scope
|
||||
|
||||
The licenses granted in this Section 2 are the only rights granted under
|
||||
this License. No additional rights or licenses will be implied from the
|
||||
distribution or licensing of Covered Software under this License.
|
||||
Notwithstanding Section 2.1(b) above, no patent license is granted by a
|
||||
Contributor:
|
||||
|
||||
(a) for any code that a Contributor has removed from Covered Software;
|
||||
or
|
||||
|
||||
(b) for infringements caused by: (i) Your and any other third party's
|
||||
modifications of Covered Software, or (ii) the combination of its
|
||||
Contributions with other software (except as part of its Contributor
|
||||
Version); or
|
||||
|
||||
(c) under Patent Claims infringed by Covered Software in the absence of
|
||||
its Contributions.
|
||||
|
||||
This License does not grant any rights in the trademarks, service marks,
|
||||
or logos of any Contributor (except as may be necessary to comply with
|
||||
the notice requirements in Section 3.4).
|
||||
|
||||
2.4. Subsequent Licenses
|
||||
|
||||
No Contributor makes additional grants as a result of Your choice to
|
||||
distribute the Covered Software under a subsequent version of this
|
||||
License (see Section 10.2) or under the terms of a Secondary License (if
|
||||
permitted under the terms of Section 3.3).
|
||||
|
||||
2.5. Representation
|
||||
|
||||
Each Contributor represents that the Contributor believes its
|
||||
Contributions are its original creation(s) or it has sufficient rights
|
||||
to grant the rights to its Contributions conveyed by this License.
|
||||
|
||||
2.6. Fair Use
|
||||
|
||||
This License is not intended to limit any rights You have under
|
||||
applicable copyright doctrines of fair use, fair dealing, or other
|
||||
equivalents.
|
||||
|
||||
2.7. Conditions
|
||||
|
||||
Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
|
||||
in Section 2.1.
|
||||
|
||||
3. Responsibilities
|
||||
-------------------
|
||||
|
||||
3.1. Distribution of Source Form
|
||||
|
||||
All distribution of Covered Software in Source Code Form, including any
|
||||
Modifications that You create or to which You contribute, must be under
|
||||
the terms of this License. You must inform recipients that the Source
|
||||
Code Form of the Covered Software is governed by the terms of this
|
||||
License, and how they can obtain a copy of this License. You may not
|
||||
attempt to alter or restrict the recipients' rights in the Source Code
|
||||
Form.
|
||||
|
||||
3.2. Distribution of Executable Form
|
||||
|
||||
If You distribute Covered Software in Executable Form then:
|
||||
|
||||
(a) such Covered Software must also be made available in Source Code
|
||||
Form, as described in Section 3.1, and You must inform recipients of
|
||||
the Executable Form how they can obtain a copy of such Source Code
|
||||
Form by reasonable means in a timely manner, at a charge no more
|
||||
than the cost of distribution to the recipient; and
|
||||
|
||||
(b) You may distribute such Executable Form under the terms of this
|
||||
License, or sublicense it under different terms, provided that the
|
||||
license for the Executable Form does not attempt to limit or alter
|
||||
the recipients' rights in the Source Code Form under this License.
|
||||
|
||||
3.3. Distribution of a Larger Work
|
||||
|
||||
You may create and distribute a Larger Work under terms of Your choice,
|
||||
provided that You also comply with the requirements of this License for
|
||||
the Covered Software. If the Larger Work is a combination of Covered
|
||||
Software with a work governed by one or more Secondary Licenses, and the
|
||||
Covered Software is not Incompatible With Secondary Licenses, this
|
||||
License permits You to additionally distribute such Covered Software
|
||||
under the terms of such Secondary License(s), so that the recipient of
|
||||
the Larger Work may, at their option, further distribute the Covered
|
||||
Software under the terms of either this License or such Secondary
|
||||
License(s).
|
||||
|
||||
3.4. Notices
|
||||
|
||||
You may not remove or alter the substance of any license notices
|
||||
(including copyright notices, patent notices, disclaimers of warranty,
|
||||
or limitations of liability) contained within the Source Code Form of
|
||||
the Covered Software, except that You may alter any license notices to
|
||||
the extent required to remedy known factual inaccuracies.
|
||||
|
||||
3.5. Application of Additional Terms
|
||||
|
||||
You may choose to offer, and to charge a fee for, warranty, support,
|
||||
indemnity or liability obligations to one or more recipients of Covered
|
||||
Software. However, You may do so only on Your own behalf, and not on
|
||||
behalf of any Contributor. You must make it absolutely clear that any
|
||||
such warranty, support, indemnity, or liability obligation is offered by
|
||||
You alone, and You hereby agree to indemnify every Contributor for any
|
||||
liability incurred by such Contributor as a result of warranty, support,
|
||||
indemnity or liability terms You offer. You may include additional
|
||||
disclaimers of warranty and limitations of liability specific to any
|
||||
jurisdiction.
|
||||
|
||||
4. Inability to Comply Due to Statute or Regulation
|
||||
---------------------------------------------------
|
||||
|
||||
If it is impossible for You to comply with any of the terms of this
|
||||
License with respect to some or all of the Covered Software due to
|
||||
statute, judicial order, or regulation then You must: (a) comply with
|
||||
the terms of this License to the maximum extent possible; and (b)
|
||||
describe the limitations and the code they affect. Such description must
|
||||
be placed in a text file included with all distributions of the Covered
|
||||
Software under this License. Except to the extent prohibited by statute
|
||||
or regulation, such description must be sufficiently detailed for a
|
||||
recipient of ordinary skill to be able to understand it.
|
||||
|
||||
5. Termination
|
||||
--------------
|
||||
|
||||
5.1. The rights granted under this License will terminate automatically
|
||||
if You fail to comply with any of its terms. However, if You become
|
||||
compliant, then the rights granted under this License from a particular
|
||||
Contributor are reinstated (a) provisionally, unless and until such
|
||||
Contributor explicitly and finally terminates Your grants, and (b) on an
|
||||
ongoing basis, if such Contributor fails to notify You of the
|
||||
non-compliance by some reasonable means prior to 60 days after You have
|
||||
come back into compliance. Moreover, Your grants from a particular
|
||||
Contributor are reinstated on an ongoing basis if such Contributor
|
||||
notifies You of the non-compliance by some reasonable means, this is the
|
||||
first time You have received notice of non-compliance with this License
|
||||
from such Contributor, and You become compliant prior to 30 days after
|
||||
Your receipt of the notice.
|
||||
|
||||
5.2. If You initiate litigation against any entity by asserting a patent
|
||||
infringement claim (excluding declaratory judgment actions,
|
||||
counter-claims, and cross-claims) alleging that a Contributor Version
|
||||
directly or indirectly infringes any patent, then the rights granted to
|
||||
You by any and all Contributors for the Covered Software under Section
|
||||
2.1 of this License shall terminate.
|
||||
|
||||
5.3. In the event of termination under Sections 5.1 or 5.2 above, all
|
||||
end user license agreements (excluding distributors and resellers) which
|
||||
have been validly granted by You or Your distributors under this License
|
||||
prior to termination shall survive termination.
|
||||
|
||||
************************************************************************
|
||||
* *
|
||||
* 6. Disclaimer of Warranty *
|
||||
* ------------------------- *
|
||||
* *
|
||||
* Covered Software is provided under this License on an "as is" *
|
||||
* basis, without warranty of any kind, either expressed, implied, or *
|
||||
* statutory, including, without limitation, warranties that the *
|
||||
* Covered Software is free of defects, merchantable, fit for a *
|
||||
* particular purpose or non-infringing. The entire risk as to the *
|
||||
* quality and performance of the Covered Software is with You. *
|
||||
* Should any Covered Software prove defective in any respect, You *
|
||||
* (not any Contributor) assume the cost of any necessary servicing, *
|
||||
* repair, or correction. This disclaimer of warranty constitutes an *
|
||||
* essential part of this License. No use of any Covered Software is *
|
||||
* authorized under this License except under this disclaimer. *
|
||||
* *
|
||||
************************************************************************
|
||||
|
||||
************************************************************************
|
||||
* *
|
||||
* 7. Limitation of Liability *
|
||||
* -------------------------- *
|
||||
* *
|
||||
* Under no circumstances and under no legal theory, whether tort *
|
||||
* (including negligence), contract, or otherwise, shall any *
|
||||
* Contributor, or anyone who distributes Covered Software as *
|
||||
* permitted above, be liable to You for any direct, indirect, *
|
||||
* special, incidental, or consequential damages of any character *
|
||||
* including, without limitation, damages for lost profits, loss of *
|
||||
* goodwill, work stoppage, computer failure or malfunction, or any *
|
||||
* and all other commercial damages or losses, even if such party *
|
||||
* shall have been informed of the possibility of such damages. This *
|
||||
* limitation of liability shall not apply to liability for death or *
|
||||
* personal injury resulting from such party's negligence to the *
|
||||
* extent applicable law prohibits such limitation. Some *
|
||||
* jurisdictions do not allow the exclusion or limitation of *
|
||||
* incidental or consequential damages, so this exclusion and *
|
||||
* limitation may not apply to You. *
|
||||
* *
|
||||
************************************************************************
|
||||
|
||||
8. Litigation
|
||||
-------------
|
||||
|
||||
Any litigation relating to this License may be brought only in the
|
||||
courts of a jurisdiction where the defendant maintains its principal
|
||||
place of business and such litigation shall be governed by laws of that
|
||||
jurisdiction, without reference to its conflict-of-law provisions.
|
||||
Nothing in this Section shall prevent a party's ability to bring
|
||||
cross-claims or counter-claims.
|
||||
|
||||
9. Miscellaneous
|
||||
----------------
|
||||
|
||||
This License represents the complete agreement concerning the subject
|
||||
matter hereof. If any provision of this License is held to be
|
||||
unenforceable, such provision shall be reformed only to the extent
|
||||
necessary to make it enforceable. Any law or regulation which provides
|
||||
that the language of a contract shall be construed against the drafter
|
||||
shall not be used to construe this License against a Contributor.
|
||||
|
||||
10. Versions of the License
|
||||
---------------------------
|
||||
|
||||
10.1. New Versions
|
||||
|
||||
Mozilla Foundation is the license steward. Except as provided in Section
|
||||
10.3, no one other than the license steward has the right to modify or
|
||||
publish new versions of this License. Each version will be given a
|
||||
distinguishing version number.
|
||||
|
||||
10.2. Effect of New Versions
|
||||
|
||||
You may distribute the Covered Software under the terms of the version
|
||||
of the License under which You originally received the Covered Software,
|
||||
or under the terms of any subsequent version published by the license
|
||||
steward.
|
||||
|
||||
10.3. Modified Versions
|
||||
|
||||
If you create software not governed by this License, and you want to
|
||||
create a new license for such software, you may create and use a
|
||||
modified version of this License if you rename the license and remove
|
||||
any references to the name of the license steward (except to note that
|
||||
such modified license differs from this License).
|
||||
|
||||
10.4. Distributing Source Code Form that is Incompatible With Secondary
|
||||
Licenses
|
||||
|
||||
If You choose to distribute Source Code Form that is Incompatible With
|
||||
Secondary Licenses under the terms of this version of the License, the
|
||||
notice described in Exhibit B of this License must be attached.
|
||||
|
||||
Exhibit A - Source Code Form License Notice
|
||||
-------------------------------------------
|
||||
|
||||
This Source Code Form is subject to the terms of the Mozilla Public
|
||||
License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
|
||||
If it is not possible or desirable to put the notice in a particular
|
||||
file, then You may include the notice in a location (such as a LICENSE
|
||||
file in a relevant directory) where a recipient would be likely to look
|
||||
for such a notice.
|
||||
|
||||
You may add additional accurate notices of copyright ownership.
|
||||
|
||||
Exhibit B - "Incompatible With Secondary Licenses" Notice
|
||||
---------------------------------------------------------
|
||||
|
||||
This Source Code Form is "Incompatible With Secondary Licenses", as
|
||||
defined by the Mozilla Public License, v. 2.0.
|
||||
+20
@@ -0,0 +1,20 @@
|
||||
install:
|
||||
go install -v
|
||||
|
||||
build:
|
||||
go build -v ./...
|
||||
|
||||
lint:
|
||||
golint ./...
|
||||
go vet ./...
|
||||
|
||||
test:
|
||||
go test -v ./... --cover
|
||||
|
||||
deps:
|
||||
go get -u gopkg.in/cenkalti/backoff.v1
|
||||
go get -u github.com/golang/lint/golint
|
||||
go get -u github.com/stretchr/testify
|
||||
|
||||
clean:
|
||||
go clean
|
||||
+191
@@ -0,0 +1,191 @@
|
||||
# SSE - Server Sent Events Client/Server Library for Go
|
||||
|
||||
## Synopsis
|
||||
|
||||
SSE is a client/server implementation for Server Sent Events for Golang.
|
||||
|
||||
## Build status
|
||||
|
||||
* Master: [](https://circleci.com/gh/r3labs/sse)
|
||||
|
||||
## Quick start
|
||||
|
||||
To install:
|
||||
```
|
||||
go get github.com/r3labs/sse/v2
|
||||
```
|
||||
|
||||
To Test:
|
||||
|
||||
```sh
|
||||
$ make deps
|
||||
$ make test
|
||||
```
|
||||
|
||||
#### Example Server
|
||||
|
||||
There are two parts of the server. It is comprised of the message scheduler and a http handler function.
|
||||
The messaging system is started when running:
|
||||
|
||||
```go
|
||||
func main() {
|
||||
server := sse.New()
|
||||
}
|
||||
```
|
||||
|
||||
To add a stream to this handler:
|
||||
|
||||
```go
|
||||
func main() {
|
||||
server := sse.New()
|
||||
server.CreateStream("messages")
|
||||
}
|
||||
```
|
||||
|
||||
This creates a new stream inside of the scheduler. Seeing as there are no consumers, publishing a message to this channel will do nothing.
|
||||
Clients can connect to this stream once the http handler is started by specifying _stream_ as a url parameter, like so:
|
||||
|
||||
```
|
||||
http://server/events?stream=messages
|
||||
```
|
||||
|
||||
|
||||
In order to start the http server:
|
||||
|
||||
```go
|
||||
func main() {
|
||||
server := sse.New()
|
||||
|
||||
// Create a new Mux and set the handler
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/events", server.ServeHTTP)
|
||||
|
||||
http.ListenAndServe(":8080", mux)
|
||||
}
|
||||
```
|
||||
|
||||
To publish messages to a stream:
|
||||
|
||||
```go
|
||||
func main() {
|
||||
server := sse.New()
|
||||
|
||||
// Publish a payload to the stream
|
||||
server.Publish("messages", &sse.Event{
|
||||
Data: []byte("ping"),
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
Please note there must be a stream with the name you specify and there must be subscribers to that stream
|
||||
|
||||
A way to detect disconnected clients:
|
||||
|
||||
```go
|
||||
func main() {
|
||||
server := sse.New()
|
||||
|
||||
mux := http.NewServeMux()
|
||||
mux.HandleFunc("/events", func(w http.ResponseWriter, r *http.Request) {
|
||||
go func() {
|
||||
// Received Browser Disconnection
|
||||
<-r.Context().Done()
|
||||
println("The client is disconnected here")
|
||||
return
|
||||
}()
|
||||
|
||||
server.ServeHTTP(w, r)
|
||||
})
|
||||
|
||||
http.ListenAndServe(":8080", mux)
|
||||
}
|
||||
```
|
||||
|
||||
#### Example Client
|
||||
|
||||
The client exposes a way to connect to an SSE server. The client can also handle multiple events under the same url.
|
||||
|
||||
To create a new client:
|
||||
|
||||
```go
|
||||
func main() {
|
||||
client := sse.NewClient("http://server/events")
|
||||
}
|
||||
```
|
||||
|
||||
To subscribe to an event stream, please use the Subscribe function. This accepts the name of the stream and a handler function:
|
||||
|
||||
```go
|
||||
func main() {
|
||||
client := sse.NewClient("http://server/events")
|
||||
|
||||
client.Subscribe("messages", func(msg *sse.Event) {
|
||||
// Got some data!
|
||||
fmt.Println(msg.Data)
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
Please note that this function will block the current thread. You can run this function in a go routine.
|
||||
|
||||
If you wish to have events sent to a channel, you can use SubscribeChan:
|
||||
|
||||
```go
|
||||
func main() {
|
||||
events := make(chan *sse.Event)
|
||||
|
||||
client := sse.NewClient("http://server/events")
|
||||
client.SubscribeChan("messages", events)
|
||||
}
|
||||
```
|
||||
|
||||
#### HTTP client parameters
|
||||
|
||||
To add additional parameters to the http client, such as disabling ssl verification for self signed certs, you can override the http client or update its options:
|
||||
|
||||
```go
|
||||
func main() {
|
||||
client := sse.NewClient("http://server/events")
|
||||
client.Connection.Transport = &http.Transport{
|
||||
TLSClientConfig: &tls.Config{InsecureSkipVerify: true},
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
#### URL query parameters
|
||||
|
||||
To set custom query parameters on the client or disable the stream parameter altogether:
|
||||
|
||||
```go
|
||||
func main() {
|
||||
client := sse.NewClient("http://server/events?search=example")
|
||||
|
||||
client.SubscribeRaw(func(msg *sse.Event) {
|
||||
// Got some data!
|
||||
fmt.Println(msg.Data)
|
||||
})
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
## Contributing
|
||||
|
||||
Please read through our
|
||||
[contributing guidelines](CONTRIBUTING.md).
|
||||
Included are directions for opening issues, coding standards, and notes on
|
||||
development.
|
||||
|
||||
Moreover, if your pull request contains patches or features, you must include
|
||||
relevant unit tests.
|
||||
|
||||
## Versioning
|
||||
|
||||
For transparency into our release cycle and in striving to maintain backward
|
||||
compatibility, this project is maintained under [the Semantic Versioning guidelines](http://semver.org/).
|
||||
|
||||
## Copyright and License
|
||||
|
||||
Code and documentation copyright since 2015 r3labs.io authors.
|
||||
|
||||
Code released under
|
||||
[the Mozilla Public License Version 2.0](LICENSE).
|
||||
+390
@@ -0,0 +1,390 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
||||
|
||||
package sse
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"context"
|
||||
"encoding/base64"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"sync"
|
||||
"sync/atomic"
|
||||
"time"
|
||||
|
||||
"gopkg.in/cenkalti/backoff.v1"
|
||||
)
|
||||
|
||||
var (
|
||||
headerID = []byte("id:")
|
||||
headerData = []byte("data:")
|
||||
headerEvent = []byte("event:")
|
||||
headerRetry = []byte("retry:")
|
||||
)
|
||||
|
||||
func ClientMaxBufferSize(s int) func(c *Client) {
|
||||
return func(c *Client) {
|
||||
c.maxBufferSize = s
|
||||
}
|
||||
}
|
||||
|
||||
// ConnCallback defines a function to be called on a particular connection event
|
||||
type ConnCallback func(c *Client)
|
||||
|
||||
// ResponseValidator validates a response
|
||||
type ResponseValidator func(c *Client, resp *http.Response) error
|
||||
|
||||
// Client handles an incoming server stream
|
||||
type Client struct {
|
||||
Retry time.Time
|
||||
ReconnectStrategy backoff.BackOff
|
||||
disconnectcb ConnCallback
|
||||
connectedcb ConnCallback
|
||||
subscribed map[chan *Event]chan struct{}
|
||||
Headers map[string]string
|
||||
ReconnectNotify backoff.Notify
|
||||
ResponseValidator ResponseValidator
|
||||
Connection *http.Client
|
||||
URL string
|
||||
LastEventID atomic.Value // []byte
|
||||
maxBufferSize int
|
||||
mu sync.Mutex
|
||||
EncodingBase64 bool
|
||||
Connected bool
|
||||
}
|
||||
|
||||
// NewClient creates a new client
|
||||
func NewClient(url string, opts ...func(c *Client)) *Client {
|
||||
c := &Client{
|
||||
URL: url,
|
||||
Connection: &http.Client{},
|
||||
Headers: make(map[string]string),
|
||||
subscribed: make(map[chan *Event]chan struct{}),
|
||||
maxBufferSize: 1 << 16,
|
||||
}
|
||||
|
||||
for _, opt := range opts {
|
||||
opt(c)
|
||||
}
|
||||
|
||||
return c
|
||||
}
|
||||
|
||||
// Subscribe to a data stream
|
||||
func (c *Client) Subscribe(stream string, handler func(msg *Event)) error {
|
||||
return c.SubscribeWithContext(context.Background(), stream, handler)
|
||||
}
|
||||
|
||||
// SubscribeWithContext to a data stream with context
|
||||
func (c *Client) SubscribeWithContext(ctx context.Context, stream string, handler func(msg *Event)) error {
|
||||
operation := func() error {
|
||||
resp, err := c.request(ctx, stream)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if validator := c.ResponseValidator; validator != nil {
|
||||
err = validator(c, resp)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
} else if resp.StatusCode != 200 {
|
||||
resp.Body.Close()
|
||||
return fmt.Errorf("could not connect to stream: %s", http.StatusText(resp.StatusCode))
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
|
||||
reader := NewEventStreamReader(resp.Body, c.maxBufferSize)
|
||||
eventChan, errorChan := c.startReadLoop(reader)
|
||||
|
||||
for {
|
||||
select {
|
||||
case err = <-errorChan:
|
||||
return err
|
||||
case msg := <-eventChan:
|
||||
handler(msg)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Apply user specified reconnection strategy or default to standard NewExponentialBackOff() reconnection method
|
||||
var err error
|
||||
if c.ReconnectStrategy != nil {
|
||||
err = backoff.RetryNotify(operation, c.ReconnectStrategy, c.ReconnectNotify)
|
||||
} else {
|
||||
err = backoff.RetryNotify(operation, backoff.NewExponentialBackOff(), c.ReconnectNotify)
|
||||
}
|
||||
return err
|
||||
}
|
||||
|
||||
// SubscribeChan sends all events to the provided channel
|
||||
func (c *Client) SubscribeChan(stream string, ch chan *Event) error {
|
||||
return c.SubscribeChanWithContext(context.Background(), stream, ch)
|
||||
}
|
||||
|
||||
// SubscribeChanWithContext sends all events to the provided channel with context
|
||||
func (c *Client) SubscribeChanWithContext(ctx context.Context, stream string, ch chan *Event) error {
|
||||
var connected bool
|
||||
errch := make(chan error)
|
||||
c.mu.Lock()
|
||||
c.subscribed[ch] = make(chan struct{})
|
||||
c.mu.Unlock()
|
||||
|
||||
operation := func() error {
|
||||
resp, err := c.request(ctx, stream)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if validator := c.ResponseValidator; validator != nil {
|
||||
err = validator(c, resp)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
} else if resp.StatusCode != 200 {
|
||||
resp.Body.Close()
|
||||
return fmt.Errorf("could not connect to stream: %s", http.StatusText(resp.StatusCode))
|
||||
}
|
||||
defer resp.Body.Close()
|
||||
|
||||
if !connected {
|
||||
// Notify connect
|
||||
errch <- nil
|
||||
connected = true
|
||||
}
|
||||
|
||||
reader := NewEventStreamReader(resp.Body, c.maxBufferSize)
|
||||
eventChan, errorChan := c.startReadLoop(reader)
|
||||
|
||||
for {
|
||||
var msg *Event
|
||||
// Wait for message to arrive or exit
|
||||
select {
|
||||
case <-c.subscribed[ch]:
|
||||
return nil
|
||||
case err = <-errorChan:
|
||||
return err
|
||||
case msg = <-eventChan:
|
||||
}
|
||||
|
||||
// Wait for message to be sent or exit
|
||||
if msg != nil {
|
||||
select {
|
||||
case <-c.subscribed[ch]:
|
||||
return nil
|
||||
case ch <- msg:
|
||||
// message sent
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
go func() {
|
||||
defer c.cleanup(ch)
|
||||
// Apply user specified reconnection strategy or default to standard NewExponentialBackOff() reconnection method
|
||||
var err error
|
||||
if c.ReconnectStrategy != nil {
|
||||
err = backoff.RetryNotify(operation, c.ReconnectStrategy, c.ReconnectNotify)
|
||||
} else {
|
||||
err = backoff.RetryNotify(operation, backoff.NewExponentialBackOff(), c.ReconnectNotify)
|
||||
}
|
||||
|
||||
// channel closed once connected
|
||||
if err != nil && !connected {
|
||||
errch <- err
|
||||
}
|
||||
}()
|
||||
err := <-errch
|
||||
close(errch)
|
||||
return err
|
||||
}
|
||||
|
||||
func (c *Client) startReadLoop(reader *EventStreamReader) (chan *Event, chan error) {
|
||||
outCh := make(chan *Event)
|
||||
erChan := make(chan error)
|
||||
go c.readLoop(reader, outCh, erChan)
|
||||
return outCh, erChan
|
||||
}
|
||||
|
||||
func (c *Client) readLoop(reader *EventStreamReader, outCh chan *Event, erChan chan error) {
|
||||
for {
|
||||
// Read each new line and process the type of event
|
||||
event, err := reader.ReadEvent()
|
||||
if err != nil {
|
||||
if err == io.EOF {
|
||||
erChan <- nil
|
||||
return
|
||||
}
|
||||
// run user specified disconnect function
|
||||
if c.disconnectcb != nil {
|
||||
c.Connected = false
|
||||
c.disconnectcb(c)
|
||||
}
|
||||
erChan <- err
|
||||
return
|
||||
}
|
||||
|
||||
if !c.Connected && c.connectedcb != nil {
|
||||
c.Connected = true
|
||||
c.connectedcb(c)
|
||||
}
|
||||
|
||||
// If we get an error, ignore it.
|
||||
var msg *Event
|
||||
if msg, err = c.processEvent(event); err == nil {
|
||||
if len(msg.ID) > 0 {
|
||||
c.LastEventID.Store(msg.ID)
|
||||
} else {
|
||||
msg.ID, _ = c.LastEventID.Load().([]byte)
|
||||
}
|
||||
|
||||
// Send downstream if the event has something useful
|
||||
if msg.hasContent() {
|
||||
outCh <- msg
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// SubscribeRaw to an sse endpoint
|
||||
func (c *Client) SubscribeRaw(handler func(msg *Event)) error {
|
||||
return c.Subscribe("", handler)
|
||||
}
|
||||
|
||||
// SubscribeRawWithContext to an sse endpoint with context
|
||||
func (c *Client) SubscribeRawWithContext(ctx context.Context, handler func(msg *Event)) error {
|
||||
return c.SubscribeWithContext(ctx, "", handler)
|
||||
}
|
||||
|
||||
// SubscribeChanRaw sends all events to the provided channel
|
||||
func (c *Client) SubscribeChanRaw(ch chan *Event) error {
|
||||
return c.SubscribeChan("", ch)
|
||||
}
|
||||
|
||||
// SubscribeChanRawWithContext sends all events to the provided channel with context
|
||||
func (c *Client) SubscribeChanRawWithContext(ctx context.Context, ch chan *Event) error {
|
||||
return c.SubscribeChanWithContext(ctx, "", ch)
|
||||
}
|
||||
|
||||
// Unsubscribe unsubscribes a channel
|
||||
func (c *Client) Unsubscribe(ch chan *Event) {
|
||||
c.mu.Lock()
|
||||
defer c.mu.Unlock()
|
||||
|
||||
if c.subscribed[ch] != nil {
|
||||
c.subscribed[ch] <- struct{}{}
|
||||
}
|
||||
}
|
||||
|
||||
// OnDisconnect specifies the function to run when the connection disconnects
|
||||
func (c *Client) OnDisconnect(fn ConnCallback) {
|
||||
c.disconnectcb = fn
|
||||
}
|
||||
|
||||
// OnConnect specifies the function to run when the connection is successful
|
||||
func (c *Client) OnConnect(fn ConnCallback) {
|
||||
c.connectedcb = fn
|
||||
}
|
||||
|
||||
func (c *Client) request(ctx context.Context, stream string) (*http.Response, error) {
|
||||
req, err := http.NewRequest("GET", c.URL, nil)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
req = req.WithContext(ctx)
|
||||
|
||||
// Setup request, specify stream to connect to
|
||||
if stream != "" {
|
||||
query := req.URL.Query()
|
||||
query.Add("stream", stream)
|
||||
req.URL.RawQuery = query.Encode()
|
||||
}
|
||||
|
||||
req.Header.Set("Cache-Control", "no-cache")
|
||||
req.Header.Set("Accept", "text/event-stream")
|
||||
req.Header.Set("Connection", "keep-alive")
|
||||
|
||||
lastID, exists := c.LastEventID.Load().([]byte)
|
||||
if exists && lastID != nil {
|
||||
req.Header.Set("Last-Event-ID", string(lastID))
|
||||
}
|
||||
|
||||
// Add user specified headers
|
||||
for k, v := range c.Headers {
|
||||
req.Header.Set(k, v)
|
||||
}
|
||||
|
||||
return c.Connection.Do(req)
|
||||
}
|
||||
|
||||
func (c *Client) processEvent(msg []byte) (event *Event, err error) {
|
||||
var e Event
|
||||
|
||||
if len(msg) < 1 {
|
||||
return nil, errors.New("event message was empty")
|
||||
}
|
||||
|
||||
// Normalize the crlf to lf to make it easier to split the lines.
|
||||
// Split the line by "\n" or "\r", per the spec.
|
||||
for _, line := range bytes.FieldsFunc(msg, func(r rune) bool { return r == '\n' || r == '\r' }) {
|
||||
switch {
|
||||
case bytes.HasPrefix(line, headerID):
|
||||
e.ID = append([]byte(nil), trimHeader(len(headerID), line)...)
|
||||
case bytes.HasPrefix(line, headerData):
|
||||
// The spec allows for multiple data fields per event, concatenated them with "\n".
|
||||
e.Data = append(e.Data[:], append(trimHeader(len(headerData), line), byte('\n'))...)
|
||||
// The spec says that a line that simply contains the string "data" should be treated as a data field with an empty body.
|
||||
case bytes.Equal(line, bytes.TrimSuffix(headerData, []byte(":"))):
|
||||
e.Data = append(e.Data, byte('\n'))
|
||||
case bytes.HasPrefix(line, headerEvent):
|
||||
e.Event = append([]byte(nil), trimHeader(len(headerEvent), line)...)
|
||||
case bytes.HasPrefix(line, headerRetry):
|
||||
e.Retry = append([]byte(nil), trimHeader(len(headerRetry), line)...)
|
||||
default:
|
||||
// Ignore any garbage that doesn't match what we're looking for.
|
||||
}
|
||||
}
|
||||
|
||||
// Trim the last "\n" per the spec.
|
||||
e.Data = bytes.TrimSuffix(e.Data, []byte("\n"))
|
||||
|
||||
if c.EncodingBase64 {
|
||||
buf := make([]byte, base64.StdEncoding.DecodedLen(len(e.Data)))
|
||||
|
||||
n, err := base64.StdEncoding.Decode(buf, e.Data)
|
||||
if err != nil {
|
||||
err = fmt.Errorf("failed to decode event message: %s", err)
|
||||
}
|
||||
e.Data = buf[:n]
|
||||
}
|
||||
return &e, err
|
||||
}
|
||||
|
||||
func (c *Client) cleanup(ch chan *Event) {
|
||||
c.mu.Lock()
|
||||
defer c.mu.Unlock()
|
||||
|
||||
if c.subscribed[ch] != nil {
|
||||
close(c.subscribed[ch])
|
||||
delete(c.subscribed, ch)
|
||||
}
|
||||
}
|
||||
|
||||
func trimHeader(size int, data []byte) []byte {
|
||||
if data == nil || len(data) < size {
|
||||
return data
|
||||
}
|
||||
|
||||
data = data[size:]
|
||||
// Remove optional leading whitespace
|
||||
if len(data) > 0 && data[0] == 32 {
|
||||
data = data[1:]
|
||||
}
|
||||
// Remove trailing new line
|
||||
if len(data) > 0 && data[len(data)-1] == 10 {
|
||||
data = data[:len(data)-1]
|
||||
}
|
||||
return data
|
||||
}
|
||||
+114
@@ -0,0 +1,114 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
||||
|
||||
package sse
|
||||
|
||||
import (
|
||||
"bufio"
|
||||
"bytes"
|
||||
"context"
|
||||
"io"
|
||||
"time"
|
||||
)
|
||||
|
||||
// Event holds all of the event source fields
|
||||
type Event struct {
|
||||
timestamp time.Time
|
||||
ID []byte
|
||||
Data []byte
|
||||
Event []byte
|
||||
Retry []byte
|
||||
Comment []byte
|
||||
}
|
||||
|
||||
func (e *Event) hasContent() bool {
|
||||
return len(e.ID) > 0 || len(e.Data) > 0 || len(e.Event) > 0 || len(e.Retry) > 0
|
||||
}
|
||||
|
||||
// EventStreamReader scans an io.Reader looking for EventStream messages.
|
||||
type EventStreamReader struct {
|
||||
scanner *bufio.Scanner
|
||||
}
|
||||
|
||||
// NewEventStreamReader creates an instance of EventStreamReader.
|
||||
func NewEventStreamReader(eventStream io.Reader, maxBufferSize int) *EventStreamReader {
|
||||
scanner := bufio.NewScanner(eventStream)
|
||||
initBufferSize := minPosInt(4096, maxBufferSize)
|
||||
scanner.Buffer(make([]byte, initBufferSize), maxBufferSize)
|
||||
|
||||
split := func(data []byte, atEOF bool) (int, []byte, error) {
|
||||
if atEOF && len(data) == 0 {
|
||||
return 0, nil, nil
|
||||
}
|
||||
|
||||
// We have a full event payload to parse.
|
||||
if i, nlen := containsDoubleNewline(data); i >= 0 {
|
||||
return i + nlen, data[0:i], nil
|
||||
}
|
||||
// If we're at EOF, we have all of the data.
|
||||
if atEOF {
|
||||
return len(data), data, nil
|
||||
}
|
||||
// Request more data.
|
||||
return 0, nil, nil
|
||||
}
|
||||
// Set the split function for the scanning operation.
|
||||
scanner.Split(split)
|
||||
|
||||
return &EventStreamReader{
|
||||
scanner: scanner,
|
||||
}
|
||||
}
|
||||
|
||||
// Returns a tuple containing the index of a double newline, and the number of bytes
|
||||
// represented by that sequence. If no double newline is present, the first value
|
||||
// will be negative.
|
||||
func containsDoubleNewline(data []byte) (int, int) {
|
||||
// Search for each potentially valid sequence of newline characters
|
||||
crcr := bytes.Index(data, []byte("\r\r"))
|
||||
lflf := bytes.Index(data, []byte("\n\n"))
|
||||
crlflf := bytes.Index(data, []byte("\r\n\n"))
|
||||
lfcrlf := bytes.Index(data, []byte("\n\r\n"))
|
||||
crlfcrlf := bytes.Index(data, []byte("\r\n\r\n"))
|
||||
// Find the earliest position of a double newline combination
|
||||
minPos := minPosInt(crcr, minPosInt(lflf, minPosInt(crlflf, minPosInt(lfcrlf, crlfcrlf))))
|
||||
// Detemine the length of the sequence
|
||||
nlen := 2
|
||||
if minPos == crlfcrlf {
|
||||
nlen = 4
|
||||
} else if minPos == crlflf || minPos == lfcrlf {
|
||||
nlen = 3
|
||||
}
|
||||
return minPos, nlen
|
||||
}
|
||||
|
||||
// Returns the minimum non-negative value out of the two values. If both
|
||||
// are negative, a negative value is returned.
|
||||
func minPosInt(a, b int) int {
|
||||
if a < 0 {
|
||||
return b
|
||||
}
|
||||
if b < 0 {
|
||||
return a
|
||||
}
|
||||
if a > b {
|
||||
return b
|
||||
}
|
||||
return a
|
||||
}
|
||||
|
||||
// ReadEvent scans the EventStream for events.
|
||||
func (e *EventStreamReader) ReadEvent() ([]byte, error) {
|
||||
if e.scanner.Scan() {
|
||||
event := e.scanner.Bytes()
|
||||
return event, nil
|
||||
}
|
||||
if err := e.scanner.Err(); err != nil {
|
||||
if err == context.Canceled {
|
||||
return nil, io.EOF
|
||||
}
|
||||
return nil, err
|
||||
}
|
||||
return nil, io.EOF
|
||||
}
|
||||
+43
@@ -0,0 +1,43 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
||||
|
||||
package sse
|
||||
|
||||
import (
|
||||
"strconv"
|
||||
"time"
|
||||
)
|
||||
|
||||
// EventLog holds all of previous events
|
||||
type EventLog []*Event
|
||||
|
||||
// Add event to eventlog
|
||||
func (e *EventLog) Add(ev *Event) {
|
||||
if !ev.hasContent() {
|
||||
return
|
||||
}
|
||||
|
||||
ev.ID = []byte(e.currentindex())
|
||||
ev.timestamp = time.Now()
|
||||
*e = append(*e, ev)
|
||||
}
|
||||
|
||||
// Clear events from eventlog
|
||||
func (e *EventLog) Clear() {
|
||||
*e = nil
|
||||
}
|
||||
|
||||
// Replay events to a subscriber
|
||||
func (e *EventLog) Replay(s *Subscriber) {
|
||||
for i := 0; i < len(*e); i++ {
|
||||
id, _ := strconv.Atoi(string((*e)[i].ID))
|
||||
if id >= s.eventid {
|
||||
s.connection <- (*e)[i]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (e *EventLog) currentindex() string {
|
||||
return strconv.Itoa(len(*e))
|
||||
}
|
||||
+120
@@ -0,0 +1,120 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
||||
|
||||
package sse
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"strconv"
|
||||
"time"
|
||||
)
|
||||
|
||||
// ServeHTTP serves new connections with events for a given stream ...
|
||||
func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
|
||||
flusher, err := w.(http.Flusher)
|
||||
if !err {
|
||||
http.Error(w, "Streaming unsupported!", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
|
||||
w.Header().Set("Content-Type", "text/event-stream")
|
||||
w.Header().Set("Cache-Control", "no-cache")
|
||||
w.Header().Set("Connection", "keep-alive")
|
||||
|
||||
for k, v := range s.Headers {
|
||||
w.Header().Set(k, v)
|
||||
}
|
||||
|
||||
// Get the StreamID from the URL
|
||||
streamID := r.URL.Query().Get("stream")
|
||||
if streamID == "" {
|
||||
http.Error(w, "Please specify a stream!", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
|
||||
stream := s.getStream(streamID)
|
||||
|
||||
if stream == nil {
|
||||
if !s.AutoStream {
|
||||
http.Error(w, "Stream not found!", http.StatusInternalServerError)
|
||||
return
|
||||
}
|
||||
|
||||
stream = s.CreateStream(streamID)
|
||||
}
|
||||
|
||||
eventid := 0
|
||||
if id := r.Header.Get("Last-Event-ID"); id != "" {
|
||||
var err error
|
||||
eventid, err = strconv.Atoi(id)
|
||||
if err != nil {
|
||||
http.Error(w, "Last-Event-ID must be a number!", http.StatusBadRequest)
|
||||
return
|
||||
}
|
||||
}
|
||||
|
||||
// Create the stream subscriber
|
||||
sub := stream.addSubscriber(eventid, r.URL)
|
||||
|
||||
go func() {
|
||||
<-r.Context().Done()
|
||||
|
||||
sub.close()
|
||||
|
||||
if s.AutoStream && !s.AutoReplay && stream.getSubscriberCount() == 0 {
|
||||
s.RemoveStream(streamID)
|
||||
}
|
||||
}()
|
||||
|
||||
w.WriteHeader(http.StatusOK)
|
||||
flusher.Flush()
|
||||
|
||||
// Push events to client
|
||||
for ev := range sub.connection {
|
||||
// If the data buffer is an empty string abort.
|
||||
if len(ev.Data) == 0 && len(ev.Comment) == 0 {
|
||||
break
|
||||
}
|
||||
|
||||
// if the event has expired, dont send it
|
||||
if s.EventTTL != 0 && time.Now().After(ev.timestamp.Add(s.EventTTL)) {
|
||||
continue
|
||||
}
|
||||
|
||||
if len(ev.Data) > 0 {
|
||||
fmt.Fprintf(w, "id: %s\n", ev.ID)
|
||||
|
||||
if s.SplitData {
|
||||
sd := bytes.Split(ev.Data, []byte("\n"))
|
||||
for i := range sd {
|
||||
fmt.Fprintf(w, "data: %s\n", sd[i])
|
||||
}
|
||||
} else {
|
||||
if bytes.HasPrefix(ev.Data, []byte(":")) {
|
||||
fmt.Fprintf(w, "%s\n", ev.Data)
|
||||
} else {
|
||||
fmt.Fprintf(w, "data: %s\n", ev.Data)
|
||||
}
|
||||
}
|
||||
|
||||
if len(ev.Event) > 0 {
|
||||
fmt.Fprintf(w, "event: %s\n", ev.Event)
|
||||
}
|
||||
|
||||
if len(ev.Retry) > 0 {
|
||||
fmt.Fprintf(w, "retry: %s\n", ev.Retry)
|
||||
}
|
||||
}
|
||||
|
||||
if len(ev.Comment) > 0 {
|
||||
fmt.Fprintf(w, ": %s\n", ev.Comment)
|
||||
}
|
||||
|
||||
fmt.Fprint(w, "\n")
|
||||
|
||||
flusher.Flush()
|
||||
}
|
||||
}
|
||||
+156
@@ -0,0 +1,156 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
||||
|
||||
package sse
|
||||
|
||||
import (
|
||||
"encoding/base64"
|
||||
"sync"
|
||||
"time"
|
||||
)
|
||||
|
||||
// DefaultBufferSize size of the queue that holds the streams messages.
|
||||
const DefaultBufferSize = 1024
|
||||
|
||||
// Server Is our main struct
|
||||
type Server struct {
|
||||
// Extra headers adding to the HTTP response to each client
|
||||
Headers map[string]string
|
||||
// Sets a ttl that prevents old events from being transmitted
|
||||
EventTTL time.Duration
|
||||
// Specifies the size of the message buffer for each stream
|
||||
BufferSize int
|
||||
// Encodes all data as base64
|
||||
EncodeBase64 bool
|
||||
// Splits an events data into multiple data: entries
|
||||
SplitData bool
|
||||
// Enables creation of a stream when a client connects
|
||||
AutoStream bool
|
||||
// Enables automatic replay for each new subscriber that connects
|
||||
AutoReplay bool
|
||||
|
||||
// Specifies the function to run when client subscribe or un-subscribe
|
||||
OnSubscribe func(streamID string, sub *Subscriber)
|
||||
OnUnsubscribe func(streamID string, sub *Subscriber)
|
||||
|
||||
streams map[string]*Stream
|
||||
muStreams sync.RWMutex
|
||||
}
|
||||
|
||||
// New will create a server and setup defaults
|
||||
func New() *Server {
|
||||
return &Server{
|
||||
BufferSize: DefaultBufferSize,
|
||||
AutoStream: false,
|
||||
AutoReplay: true,
|
||||
streams: make(map[string]*Stream),
|
||||
Headers: map[string]string{},
|
||||
}
|
||||
}
|
||||
|
||||
// NewWithCallback will create a server and setup defaults with callback function
|
||||
func NewWithCallback(onSubscribe, onUnsubscribe func(streamID string, sub *Subscriber)) *Server {
|
||||
return &Server{
|
||||
BufferSize: DefaultBufferSize,
|
||||
AutoStream: false,
|
||||
AutoReplay: true,
|
||||
streams: make(map[string]*Stream),
|
||||
Headers: map[string]string{},
|
||||
OnSubscribe: onSubscribe,
|
||||
OnUnsubscribe: onUnsubscribe,
|
||||
}
|
||||
}
|
||||
|
||||
// Close shuts down the server, closes all of the streams and connections
|
||||
func (s *Server) Close() {
|
||||
s.muStreams.Lock()
|
||||
defer s.muStreams.Unlock()
|
||||
|
||||
for id := range s.streams {
|
||||
s.streams[id].close()
|
||||
delete(s.streams, id)
|
||||
}
|
||||
}
|
||||
|
||||
// CreateStream will create a new stream and register it
|
||||
func (s *Server) CreateStream(id string) *Stream {
|
||||
s.muStreams.Lock()
|
||||
defer s.muStreams.Unlock()
|
||||
|
||||
if s.streams[id] != nil {
|
||||
return s.streams[id]
|
||||
}
|
||||
|
||||
str := newStream(id, s.BufferSize, s.AutoReplay, s.AutoStream, s.OnSubscribe, s.OnUnsubscribe)
|
||||
str.run()
|
||||
|
||||
s.streams[id] = str
|
||||
|
||||
return str
|
||||
}
|
||||
|
||||
// RemoveStream will remove a stream
|
||||
func (s *Server) RemoveStream(id string) {
|
||||
s.muStreams.Lock()
|
||||
defer s.muStreams.Unlock()
|
||||
|
||||
if s.streams[id] != nil {
|
||||
s.streams[id].close()
|
||||
delete(s.streams, id)
|
||||
}
|
||||
}
|
||||
|
||||
// StreamExists checks whether a stream by a given id exists
|
||||
func (s *Server) StreamExists(id string) bool {
|
||||
return s.getStream(id) != nil
|
||||
}
|
||||
|
||||
// Publish sends a mesage to every client in a streamID.
|
||||
// If the stream's buffer is full, it blocks until the message is sent out to
|
||||
// all subscribers (but not necessarily arrived the clients), or when the
|
||||
// stream is closed.
|
||||
func (s *Server) Publish(id string, event *Event) {
|
||||
stream := s.getStream(id)
|
||||
if stream == nil {
|
||||
return
|
||||
}
|
||||
|
||||
select {
|
||||
case <-stream.quit:
|
||||
case stream.event <- s.process(event):
|
||||
}
|
||||
}
|
||||
|
||||
// TryPublish is the same as Publish except that when the operation would cause
|
||||
// the call to be blocked, it simply drops the message and returns false.
|
||||
// Together with a small BufferSize, it can be useful when publishing the
|
||||
// latest message ASAP is more important than reliable delivery.
|
||||
func (s *Server) TryPublish(id string, event *Event) bool {
|
||||
stream := s.getStream(id)
|
||||
if stream == nil {
|
||||
return false
|
||||
}
|
||||
|
||||
select {
|
||||
case stream.event <- s.process(event):
|
||||
return true
|
||||
default:
|
||||
return false
|
||||
}
|
||||
}
|
||||
|
||||
func (s *Server) getStream(id string) *Stream {
|
||||
s.muStreams.RLock()
|
||||
defer s.muStreams.RUnlock()
|
||||
return s.streams[id]
|
||||
}
|
||||
|
||||
func (s *Server) process(event *Event) *Event {
|
||||
if s.EncodeBase64 {
|
||||
output := make([]byte, base64.StdEncoding.EncodedLen(len(event.Data)))
|
||||
base64.StdEncoding.Encode(output, event.Data)
|
||||
event.Data = output
|
||||
}
|
||||
return event
|
||||
}
|
||||
+153
@@ -0,0 +1,153 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
||||
|
||||
package sse
|
||||
|
||||
import (
|
||||
"net/url"
|
||||
"sync"
|
||||
"sync/atomic"
|
||||
)
|
||||
|
||||
// Stream ...
|
||||
type Stream struct {
|
||||
ID string
|
||||
event chan *Event
|
||||
quit chan struct{}
|
||||
quitOnce sync.Once
|
||||
register chan *Subscriber
|
||||
deregister chan *Subscriber
|
||||
subscribers []*Subscriber
|
||||
Eventlog EventLog
|
||||
subscriberCount int32
|
||||
// Enables replaying of eventlog to newly added subscribers
|
||||
AutoReplay bool
|
||||
isAutoStream bool
|
||||
|
||||
// Specifies the function to run when client subscribe or un-subscribe
|
||||
OnSubscribe func(streamID string, sub *Subscriber)
|
||||
OnUnsubscribe func(streamID string, sub *Subscriber)
|
||||
}
|
||||
|
||||
// newStream returns a new stream
|
||||
func newStream(id string, buffSize int, replay, isAutoStream bool, onSubscribe, onUnsubscribe func(string, *Subscriber)) *Stream {
|
||||
return &Stream{
|
||||
ID: id,
|
||||
AutoReplay: replay,
|
||||
subscribers: make([]*Subscriber, 0),
|
||||
isAutoStream: isAutoStream,
|
||||
register: make(chan *Subscriber),
|
||||
deregister: make(chan *Subscriber),
|
||||
event: make(chan *Event, buffSize),
|
||||
quit: make(chan struct{}),
|
||||
Eventlog: make(EventLog, 0),
|
||||
OnSubscribe: onSubscribe,
|
||||
OnUnsubscribe: onUnsubscribe,
|
||||
}
|
||||
}
|
||||
|
||||
func (str *Stream) run() {
|
||||
go func(str *Stream) {
|
||||
for {
|
||||
select {
|
||||
// Add new subscriber
|
||||
case subscriber := <-str.register:
|
||||
str.subscribers = append(str.subscribers, subscriber)
|
||||
if str.AutoReplay {
|
||||
str.Eventlog.Replay(subscriber)
|
||||
}
|
||||
|
||||
// Remove closed subscriber
|
||||
case subscriber := <-str.deregister:
|
||||
i := str.getSubIndex(subscriber)
|
||||
if i != -1 {
|
||||
str.removeSubscriber(i)
|
||||
}
|
||||
|
||||
if str.OnUnsubscribe != nil {
|
||||
go str.OnUnsubscribe(str.ID, subscriber)
|
||||
}
|
||||
|
||||
// Publish event to subscribers
|
||||
case event := <-str.event:
|
||||
if str.AutoReplay {
|
||||
str.Eventlog.Add(event)
|
||||
}
|
||||
for i := range str.subscribers {
|
||||
str.subscribers[i].connection <- event
|
||||
}
|
||||
|
||||
// Shutdown if the server closes
|
||||
case <-str.quit:
|
||||
// remove connections
|
||||
str.removeAllSubscribers()
|
||||
return
|
||||
}
|
||||
}
|
||||
}(str)
|
||||
}
|
||||
|
||||
func (str *Stream) close() {
|
||||
str.quitOnce.Do(func() {
|
||||
close(str.quit)
|
||||
})
|
||||
}
|
||||
|
||||
func (str *Stream) getSubIndex(sub *Subscriber) int {
|
||||
for i := range str.subscribers {
|
||||
if str.subscribers[i] == sub {
|
||||
return i
|
||||
}
|
||||
}
|
||||
return -1
|
||||
}
|
||||
|
||||
// addSubscriber will create a new subscriber on a stream
|
||||
func (str *Stream) addSubscriber(eventid int, url *url.URL) *Subscriber {
|
||||
atomic.AddInt32(&str.subscriberCount, 1)
|
||||
sub := &Subscriber{
|
||||
eventid: eventid,
|
||||
quit: str.deregister,
|
||||
connection: make(chan *Event, 64),
|
||||
URL: url,
|
||||
}
|
||||
|
||||
if str.isAutoStream {
|
||||
sub.removed = make(chan struct{}, 1)
|
||||
}
|
||||
|
||||
str.register <- sub
|
||||
|
||||
if str.OnSubscribe != nil {
|
||||
go str.OnSubscribe(str.ID, sub)
|
||||
}
|
||||
|
||||
return sub
|
||||
}
|
||||
|
||||
func (str *Stream) removeSubscriber(i int) {
|
||||
atomic.AddInt32(&str.subscriberCount, -1)
|
||||
close(str.subscribers[i].connection)
|
||||
if str.subscribers[i].removed != nil {
|
||||
str.subscribers[i].removed <- struct{}{}
|
||||
close(str.subscribers[i].removed)
|
||||
}
|
||||
str.subscribers = append(str.subscribers[:i], str.subscribers[i+1:]...)
|
||||
}
|
||||
|
||||
func (str *Stream) removeAllSubscribers() {
|
||||
for i := 0; i < len(str.subscribers); i++ {
|
||||
close(str.subscribers[i].connection)
|
||||
if str.subscribers[i].removed != nil {
|
||||
str.subscribers[i].removed <- struct{}{}
|
||||
close(str.subscribers[i].removed)
|
||||
}
|
||||
}
|
||||
atomic.StoreInt32(&str.subscriberCount, 0)
|
||||
str.subscribers = str.subscribers[:0]
|
||||
}
|
||||
|
||||
func (str *Stream) getSubscriberCount() int {
|
||||
return int(atomic.LoadInt32(&str.subscriberCount))
|
||||
}
|
||||
+24
@@ -0,0 +1,24 @@
|
||||
/* This Source Code Form is subject to the terms of the Mozilla Public
|
||||
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
||||
|
||||
package sse
|
||||
|
||||
import "net/url"
|
||||
|
||||
// Subscriber ...
|
||||
type Subscriber struct {
|
||||
quit chan *Subscriber
|
||||
connection chan *Event
|
||||
removed chan struct{}
|
||||
eventid int
|
||||
URL *url.URL
|
||||
}
|
||||
|
||||
// Close will let the stream know that the clients connection has terminated
|
||||
func (s *Subscriber) close() {
|
||||
s.quit <- s
|
||||
if s.removed != nil {
|
||||
<-s.removed
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user