1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
|
#ifndef AWS_EVENT_STREAM_CHANNEL_HANDLER_H
#define AWS_EVENT_STREAM_CHANNEL_HANDLER_H
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#include <aws/event-stream/event_stream.h>
AWS_PUSH_SANE_WARNING_LEVEL
struct aws_event_stream_channel_handler;
struct aws_channel_handler;
/**
* Invoked when an aws_event_stream_message is encountered. If the message
* parsed successfully, message will be non-null and error_code will be AWS_ERROR_SUCCESS.
* Otherwise message will be null and error_code will represent the error that was encountered.
* Note that any case that error_code was not AWS_OP_SUCCESS, the channel also shuts down.
*/
typedef void(aws_event_stream_channel_handler_on_message_received_fn)(
struct aws_event_stream_message *message,
int error_code,
void *user_data);
/**
* Invoked when an aws_event_stream_message is flushed to the IO interface. When error_code is AWS_ERROR_SUCCESS the
* write happened successfuly. Regardless, message is held from the aws_event_stream_channel_handler_write_message()
* call and should likely be freed in this callback. If error_code is non-zero, the channel will be shutdown immediately
* after this callback returns.
*/
typedef void(aws_event_stream_channel_handler_on_message_written_fn)(
struct aws_event_stream_message *message,
int error_code,
void *user_data);
struct aws_event_stream_channel_handler_options {
/** Callback for when messages are received. Can not be null. */
aws_event_stream_channel_handler_on_message_received_fn *on_message_received;
/** user data passed to message callback. Optional */
void *user_data;
/** initial window size to use for the channel. If automatic window management is set to true, this value is
* ignored. */
size_t initial_window_size;
/**
* if set to false (the default), windowing will be managed automatically for the user.
* Otherwise, after any on_message_received, the user must invoke
* aws_event_stream_channel_handler_increment_read_window()
*/
bool manual_window_management;
};
AWS_EXTERN_C_BEGIN
/**
* Allocates and initializes a new channel handler for processing aws_event_stream_message() events. Handler options
* must not be null.
*/
AWS_EVENT_STREAM_API struct aws_channel_handler *aws_event_stream_channel_handler_new(
struct aws_allocator *allocator,
const struct aws_event_stream_channel_handler_options *handler_options);
/**
* Writes an aws_event_stream_message() to the channel. Once the channel flushes or an error occurs, on_message_written
* will be invoked. message should stay valid until the callback is invoked. If an error an occurs, the channel will
* automatically be shutdown.
*/
AWS_EVENT_STREAM_API int aws_event_stream_channel_handler_write_message(
struct aws_channel_handler *handler,
struct aws_event_stream_message *message,
aws_event_stream_channel_handler_on_message_written_fn *on_message_written,
void *user_data);
/**
* Updates the read window for the channel if automatic_window_managemanet was set to false.
*/
AWS_EVENT_STREAM_API void aws_event_stream_channel_handler_increment_read_window(
struct aws_channel_handler *handler,
size_t window_update_size);
AWS_EVENT_STREAM_API void *aws_event_stream_channel_handler_get_user_data(struct aws_channel_handler *handler);
AWS_EXTERN_C_END
AWS_POP_SANE_WARNING_LEVEL
#endif /* AWS_EVENT_STREAM_CHANNEL_HANDLER_H */
|
