package
0.0.0-20250306120524-11777db3047b
Repository: https://github.com/cloudflare/cloudflared.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
IntoClientEvent unmarshals the provided ClientEvent into the proper type.
IntoServerEvent unmarshals the provided ServerEvent into the proper type.
IsClosed returns true if the websocket error is a websocket.CloseError; returns false if not a websocket.CloseError.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ReadEvent will read a message from the websocket connection and parse it into a valid ClientEvent.
ReadEvent will read a message from the websocket connection and parse it into a valid ServerEvent.
HTTP middleware setting the parsed access_token claims in the request context.
WriteEvent will write a Event type message to the websocket connection.

# Constants

Cloudflared events are signficant to cloudflared operations like connection state changes.
No description provided by the author
No description provided by the author
EventTypeKey is the custom JSON key of the LogEventType in ZeroLogEvent.
FieldsKey is a custom JSON key to match and store every other key for a zerolog event.
No description provided by the author
No description provided by the author
LevelKey aligns with the zerolog.LevelFieldName.
No description provided by the author
LevelKey aligns with the zerolog.MessageFieldName.
No description provided by the author
There is a limited idle time while not actively serving a session for a request before dropping the connection.
In the current state, an invalid command was provided by the client.
There are a limited number of available streaming log sessions that cloudflared will service, exceeding this value will return this error to incoming requests.
No description provided by the author
No description provided by the author
TimeKey aligns with the zerolog.TimeFieldName.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

ClientEvent is the base struct that informs, based of the Type field, which Event type was provided from the client.
EventLog is the event that the server sends to the client with the log events.
EventStartStreaming signifies that the client wishes to start receiving log events.
EventStopStreaming signifies that the client wishes to halt receiving log events.
Log is the basic structure of the events that are sent to the client.
Logger manages the number of management streaming log sessions.
No description provided by the author
ServerEvent is the base struct that informs, based of the Type field, which Event type was provided from the server.
No description provided by the author

# Interfaces

No description provided by the author

# Type aliases

ClientEventType represents the event types that can come from the client.
LogEventType is the way that logging messages are able to be filtered.
LogLevel corresponds to the zerolog logging levels "panic", "fatal", and "trace" are exempt from this list as they are rarely used and, at least the the first two are limited to failure conditions that lead to cloudflared shutting down.
ServerEventType represents the event types that can come from the server.