listen

package

v1.5.0 Latest Latest Go to latest Published: Jan 8, 2026 License: Apache-2.0 Imports: 20 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/hookdeck/hookdeck-cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index ¶

Constants
func FormatHealthMessage(result HealthCheckResult, targetURL *url.URL) string
func Listen(URL *url.URL, sourceQuery string, connectionFilterString string, flags Flags, ...) error
type Flags
type HealthCheckResult
- func CheckServerHealth(targetURL *url.URL, timeout time.Duration) HealthCheckResult
type ServerHealthStatus

Constants ¶

View Source

const (
	HealthHealthy     = healthcheck.HealthHealthy
	HealthUnreachable = healthcheck.HealthUnreachable
)

Variables ¶

This section is empty.

Functions ¶

func FormatHealthMessage ¶ added in v1.5.0

func FormatHealthMessage(result HealthCheckResult, targetURL *url.URL) string

FormatHealthMessage creates a user-friendly health status message This is a wrapper around the healthcheck package function for backward compatibility

func Listen ¶

func Listen(URL *url.URL, sourceQuery string, connectionFilterString string, flags Flags, config *config.Config) error

listenCmd represents the listen command

Types ¶

type Flags ¶

type Flags struct {
	NoWSS          bool
	Path           string
	MaxConnections int
	Output         string
	Filters        *hookdeck.SessionFilters
}

type HealthCheckResult ¶ added in v1.5.0

type HealthCheckResult = healthcheck.HealthCheckResult

func CheckServerHealth ¶ added in v1.5.0

func CheckServerHealth(targetURL *url.URL, timeout time.Duration) HealthCheckResult

CheckServerHealth performs a TCP connection check to the target URL This is a wrapper around the healthcheck package function for backward compatibility

type ServerHealthStatus ¶ added in v1.5.0

type ServerHealthStatus = healthcheck.ServerHealthStatus

Re-export types and constants from healthcheck subpackage for convenience

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
healthcheck
proxy
tui

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL