streams.go
author Mikael Berthe <mikael@lilotux.net>
Mon, 29 Jul 2019 21:57:47 +0200
changeset 253 0e8c8026cf40
parent 244 4508376c8fcb
permissions -rw-r--r--
Update dependencies
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
130
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 128
diff changeset
     1
/*
207
301d5b94be3f Update copyrights
Mikael Berthe <mikael@lilotux.net>
parents: 198
diff changeset
     2
Copyright 2017-2018 Mikael Berthe
130
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 128
diff changeset
     3
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 128
diff changeset
     4
Licensed under the MIT license.  Please see the LICENSE file is this directory.
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 128
diff changeset
     5
*/
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 128
diff changeset
     6
138
23d3a518d0ad Update package name in source files
Mikael Berthe <mikael@lilotux.net>
parents: 130
diff changeset
     7
package madon
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     8
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     9
import (
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    10
	"encoding/json"
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    11
	"net/url"
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    12
	"strings"
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    13
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    14
	"github.com/gorilla/websocket"
162
68df3a01e1a7 Use github.com/pkg/errors
Mikael Berthe <mikael@lilotux.net>
parents: 159
diff changeset
    15
	"github.com/pkg/errors"
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    16
)
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    17
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    18
// StreamEvent contains a single event from the streaming API
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    19
type StreamEvent struct {
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    20
	Event string      // Name of the event (error, update, notification or delete)
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    21
	Data  interface{} // Status, Notification or status ID
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    22
	Error error       // Error message from the StreamListener
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    23
}
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    24
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    25
// openStream opens a stream URL and returns an http.Response
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    26
// Note that the caller should close the connection when it's done reading
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    27
// the stream.
244
4508376c8fcb GetTimelines & StreamListener: Accept "direct" timeline
Mikael Berthe <mikael@lilotux.net>
parents: 238
diff changeset
    28
// The stream name can be "user", "local", "public", "direct", "list" or
4508376c8fcb GetTimelines & StreamListener: Accept "direct" timeline
Mikael Berthe <mikael@lilotux.net>
parents: 238
diff changeset
    29
// "hashtag".
217
cc086e49cd0c Add support for list-based streams
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    30
// When it is "hashtag", the param argument contains the hashtag.
cc086e49cd0c Add support for list-based streams
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    31
// When it is "list", the param argument contains the list ID.
cc086e49cd0c Add support for list-based streams
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    32
func (mc *Client) openStream(streamName, param string) (*websocket.Conn, error) {
cc086e49cd0c Add support for list-based streams
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    33
	var tag, list string
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    34
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    35
	switch streamName {
244
4508376c8fcb GetTimelines & StreamListener: Accept "direct" timeline
Mikael Berthe <mikael@lilotux.net>
parents: 238
diff changeset
    36
	case "user", "public", "public:local", "direct":
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    37
	case "hashtag":
217
cc086e49cd0c Add support for list-based streams
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    38
		if param == "" {
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    39
			return nil, ErrInvalidParameter
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    40
		}
217
cc086e49cd0c Add support for list-based streams
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    41
		tag = param
cc086e49cd0c Add support for list-based streams
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    42
	case "list":
cc086e49cd0c Add support for list-based streams
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    43
		if param == "" {
cc086e49cd0c Add support for list-based streams
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    44
			return nil, ErrInvalidParameter
cc086e49cd0c Add support for list-based streams
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    45
		}
cc086e49cd0c Add support for list-based streams
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    46
		list = param
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    47
	default:
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    48
		return nil, ErrInvalidParameter
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    49
	}
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    50
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    51
	if !strings.HasPrefix(mc.APIBase, "http") {
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    52
		return nil, errors.New("cannot create Websocket URL: unexpected API base URL")
128
a5a00fad7a32 Add checks for client initialization
Mikael Berthe <mikael@lilotux.net>
parents: 122
diff changeset
    53
	}
a5a00fad7a32 Add checks for client initialization
Mikael Berthe <mikael@lilotux.net>
parents: 122
diff changeset
    54
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    55
	// Build streaming websocket URL
238
1c0042e76902 Do not use a global API version
Mikael Berthe <mikael@lilotux.net>
parents: 217
diff changeset
    56
	u, err := url.Parse("ws" + mc.APIBase[4:] + "/v1/streaming/")
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    57
	if err != nil {
162
68df3a01e1a7 Use github.com/pkg/errors
Mikael Berthe <mikael@lilotux.net>
parents: 159
diff changeset
    58
		return nil, errors.Wrap(err, "cannot create Websocket URL")
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    59
	}
120
579912e9d0ef Refactor API calls
Mikael Berthe <mikael@lilotux.net>
parents: 117
diff changeset
    60
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    61
	urlParams := url.Values{}
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    62
	urlParams.Add("stream", streamName)
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    63
	urlParams.Add("access_token", mc.UserToken.AccessToken)
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    64
	if tag != "" {
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    65
		urlParams.Add("tag", tag)
217
cc086e49cd0c Add support for list-based streams
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    66
	} else if list != "" {
cc086e49cd0c Add support for list-based streams
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    67
		urlParams.Add("list", list)
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    68
	}
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    69
	u.RawQuery = urlParams.Encode()
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    70
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    71
	c, _, err := websocket.DefaultDialer.Dial(u.String(), nil)
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    72
	return c, err
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    73
}
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    74
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    75
// readStream reads from the http.Response and sends events to the events channel
122
50c7733ee886 Change StreamListener prototype
Mikael Berthe <mikael@lilotux.net>
parents: 120
diff changeset
    76
// It stops when the connection is closed or when the stopCh channel is closed.
50c7733ee886 Change StreamListener prototype
Mikael Berthe <mikael@lilotux.net>
parents: 120
diff changeset
    77
// The foroutine will close the doneCh channel when it terminates.
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    78
func (mc *Client) readStream(events chan<- StreamEvent, stopCh <-chan bool, doneCh chan bool, c *websocket.Conn) {
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    79
	defer c.Close()
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    80
	defer close(doneCh)
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    81
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    82
	go func() {
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    83
		select {
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    84
		case <-stopCh:
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    85
			// Close connection
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    86
			c.WriteMessage(websocket.CloseMessage, websocket.FormatCloseMessage(websocket.CloseNormalClosure, ""))
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    87
		case <-doneCh:
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    88
			// Leave
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    89
		}
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    90
	}()
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    91
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    92
	for {
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    93
		var msg struct {
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    94
			Event   string
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    95
			Payload interface{}
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    96
		}
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    97
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    98
		err := c.ReadJSON(&msg)
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    99
		if err != nil {
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   100
			if strings.Contains(err.Error(), "close 1000 (normal)") {
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   101
				break // Connection properly closed
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   102
			}
162
68df3a01e1a7 Use github.com/pkg/errors
Mikael Berthe <mikael@lilotux.net>
parents: 159
diff changeset
   103
			e := errors.Wrap(err, "read error")
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   104
			events <- StreamEvent{Event: "error", Error: e}
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   105
			break
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   106
		}
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   107
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   108
		var obj interface{}
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   109
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   110
		// Decode API object
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   111
		switch msg.Event {
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   112
		case "update":
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   113
			strPayload, ok := msg.Payload.(string)
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   114
			if !ok {
162
68df3a01e1a7 Use github.com/pkg/errors
Mikael Berthe <mikael@lilotux.net>
parents: 159
diff changeset
   115
				e := errors.New("could not decode status: payload isn't a string")
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   116
				events <- StreamEvent{Event: "error", Error: e}
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   117
				continue
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   118
			}
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   119
			var s Status
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   120
			if err := json.Unmarshal([]byte(strPayload), &s); err != nil {
162
68df3a01e1a7 Use github.com/pkg/errors
Mikael Berthe <mikael@lilotux.net>
parents: 159
diff changeset
   121
				e := errors.Wrap(err, "could not decode status")
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   122
				events <- StreamEvent{Event: "error", Error: e}
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   123
				continue
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   124
			}
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   125
			obj = s
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   126
		case "notification":
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   127
			strPayload, ok := msg.Payload.(string)
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   128
			if !ok {
162
68df3a01e1a7 Use github.com/pkg/errors
Mikael Berthe <mikael@lilotux.net>
parents: 159
diff changeset
   129
				e := errors.New("could not decode notification: payload isn't a string")
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   130
				events <- StreamEvent{Event: "error", Error: e}
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   131
				continue
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   132
			}
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   133
			var notif Notification
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   134
			if err := json.Unmarshal([]byte(strPayload), &notif); err != nil {
162
68df3a01e1a7 Use github.com/pkg/errors
Mikael Berthe <mikael@lilotux.net>
parents: 159
diff changeset
   135
				e := errors.Wrap(err, "could not decode notification")
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   136
				events <- StreamEvent{Event: "error", Error: e}
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   137
				continue
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   138
			}
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   139
			obj = notif
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   140
		case "delete":
198
2dd1ed9394f0 Fix stream deletion events with Mastodon v2 API
Mikael Berthe <mikael@lilotux.net>
parents: 162
diff changeset
   141
			strPayload, ok := msg.Payload.(string)
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   142
			if !ok {
198
2dd1ed9394f0 Fix stream deletion events with Mastodon v2 API
Mikael Berthe <mikael@lilotux.net>
parents: 162
diff changeset
   143
				e := errors.New("could not decode deletion: payload isn't a string")
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   144
				events <- StreamEvent{Event: "error", Error: e}
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   145
				continue
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   146
			}
198
2dd1ed9394f0 Fix stream deletion events with Mastodon v2 API
Mikael Berthe <mikael@lilotux.net>
parents: 162
diff changeset
   147
			obj = strPayload // statusID
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   148
		default:
162
68df3a01e1a7 Use github.com/pkg/errors
Mikael Berthe <mikael@lilotux.net>
parents: 159
diff changeset
   149
			e := errors.Errorf("unhandled event '%s'", msg.Event)
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   150
			events <- StreamEvent{Event: "error", Error: e}
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   151
			continue
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   152
		}
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   153
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   154
		// Send event to the channel
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   155
		events <- StreamEvent{Event: msg.Event, Data: obj}
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   156
	}
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   157
}
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   158
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   159
// StreamListener listens to a stream from the Mastodon server
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   160
// The stream 'name' can be "user", "local", "public" or "hashtag".
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   161
// For 'hashtag', the hashTag argument cannot be empty.
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   162
// The events are sent to the events channel (the errors as well).
122
50c7733ee886 Change StreamListener prototype
Mikael Berthe <mikael@lilotux.net>
parents: 120
diff changeset
   163
// The streaming is terminated if the 'stopCh' channel is closed.
50c7733ee886 Change StreamListener prototype
Mikael Berthe <mikael@lilotux.net>
parents: 120
diff changeset
   164
// The 'doneCh' channel is closed if the connection is closed by the server.
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   165
// Please note that this method launches a goroutine to listen to the events.
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   166
func (mc *Client) StreamListener(name, hashTag string, events chan<- StreamEvent, stopCh <-chan bool, doneCh chan bool) error {
138
23d3a518d0ad Update package name in source files
Mikael Berthe <mikael@lilotux.net>
parents: 130
diff changeset
   167
	if mc == nil {
23d3a518d0ad Update package name in source files
Mikael Berthe <mikael@lilotux.net>
parents: 130
diff changeset
   168
		return ErrUninitializedClient
128
a5a00fad7a32 Add checks for client initialization
Mikael Berthe <mikael@lilotux.net>
parents: 122
diff changeset
   169
	}
a5a00fad7a32 Add checks for client initialization
Mikael Berthe <mikael@lilotux.net>
parents: 122
diff changeset
   170
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   171
	conn, err := mc.openStream(name, hashTag)
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   172
	if err != nil {
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   173
		return err
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   174
	}
140
7665451f74cc streams: Use websockets
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   175
	go mc.readStream(events, stopCh, doneCh, conn)
117
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   176
	return nil
7f8ac782cf5d Add streaming API support
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   177
}