Skip to content

Commit eb27489

Browse files
committed
fixup: checkpoint
1 parent b26a172 commit eb27489

File tree

1 file changed

+21
-25
lines changed

1 file changed

+21
-25
lines changed

docs/concepts.md

Lines changed: 21 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -11,31 +11,27 @@ nav_order: 2
1111

1212
## Spec and SDK Terms
1313

14-
- [Event](https://github.com/cloudevents/spec/blob/master/spec.md#event):
14+
- [Event](https://github.com/cloudevents/spec/blob/master/spec.md#event):
1515
The canonical form of the attributes and payload of the occurrence.
16-
- [Protocol](https://github.com/cloudevents/spec/blob/master/spec.md#protocol):
17-
Protocol is the messaging protocol used to send/receive events. In sdk-go all supported
18-
Protocols are implemented through specific interfaces in
19-
[`protocol` module](../v2/protocol).
20-
- [Protocol Binding](https://github.com/cloudevents/spec/blob/master/spec.md#protocol-binding):
21-
Definition of how Events are mapped into Messages for the given Protocol. In sdk-go all
22-
supported Protocol bindings are implemented through specific interfaces in
23-
[`binding` module](../v2/binding).
24-
- [Message](https://github.com/cloudevents/spec/blob/master/spec.md#message):
25-
The encoded form of an Event for a given encoding and protocol.
26-
When a message is received in the sdk-go, the protocol implementation wraps it in a
27-
[`Message`](../v2/binding/message.go)
28-
implementation specific to that protocol. This interface defines how to read the Message,
29-
given the Protocol.
16+
- [Protocol](https://github.com/cloudevents/spec/blob/master/spec.md#protocol):
17+
Protocol is the messaging protocol used to send/receive events. In sdk-javascript
18+
the HTTP protocol is supported.
19+
- [Protocol Binding](https://github.com/cloudevents/spec/blob/master/spec.md#protocol-binding):
20+
Definition of how Events are mapped into Messages for the given Protocol. In sdk-javascript
21+
the HTTP Protocol binding is implemented in the [`HTTPReceiver`](HTTPReceiver.html).
22+
- [Message](https://github.com/cloudevents/spec/blob/master/spec.md#message):
23+
The encoded form of an Event for a given encoding and protocol.
24+
When a message is received in the sdk-javascript, the protocol implementation wraps it in a
25+
[`CloudEvent`](CloudEvent.html).
3026
- Message Writer: Logic required to take in a `Message` in a specific encoding and write out to a
31-
given Protocol (request, message). A Message Writer can be a
32-
[`StructuredWriter`](../v2/binding/structured_writer.go),
33-
a [`BinaryWriter`](../v2/binding/binary_writer.go) or both, depending on what encodings a
27+
given Protocol (request, message). A Message Writer can be a
28+
[`StructuredWriter`](../v2/binding/structured_writer.go),
29+
a [`BinaryWriter`](../v2/binding/binary_writer.go) or both, depending on what encodings a
3430
Protocol supports.
35-
- [`Client`](../v2/client/client.go): Interface to interact with a Protocol implementation
36-
to send/receive Events. Clients also provide protocol agnostic features that can be
31+
- [`Client`](../v2/client/client.go): Interface to interact with a Protocol implementation
32+
to send/receive Events. Clients also provide protocol agnostic features that can be
3733
applied to events, such as extensions.
38-
- Extensions: Anything that extends the base requirements from the CloudEvents spec.
34+
- Extensions: Anything that extends the base requirements from the CloudEvents spec.
3935
There are several
4036
[CloudEvents supported extensions](https://github.com/cloudevents/spec/tree/master/extensions).
4137

@@ -44,14 +40,14 @@ nav_order: 2
4440
The amount of the SDK adopters would like to use is up to the adopter. We
4541
support the following:
4642

47-
- [Resource Level](event_data_structure.md): An adopter could use the Event data structure to interact with CloudEvents
43+
- [Resource Level](event_data_structure.md): An adopter could use the Event data structure to interact with CloudEvents
4844
and marshal/unmarshal it to JSON.
49-
- [Message Level](protocol_implementations.md): An adopter could use directly `Message`s implementations and `Write*` functions
50-
to read and write CloudEvents messages from/to the wire, handling by hand the connection, the
45+
- [Message Level](protocol_implementations.md): An adopter could use directly `Message`s implementations and `Write*` functions
46+
to read and write CloudEvents messages from/to the wire, handling by hand the connection, the
5147
consumption and the production of messages from/to the protocol specific APIs.
5248
- [Protocol Level](protocol_implementations.md): An adopter could use Protocol implementations directly to consume/produce `Message`s
5349
without interacting with the protocol specific APIs.
54-
- [Client Level](../v2/client/client.go): An adopter selects a Protocol implementation and Events can
50+
- [Client Level](../v2/client/client.go): An adopter selects a Protocol implementation and Events can
5551
be directly sent and received without requiring interactions with `Message`s.
5652

5753
## Personas

0 commit comments

Comments
 (0)