ayame

package module
v0.0.0-...-713bc6a Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 10, 2026 License: Apache-2.0 Imports: 24 Imported by: 0

README

WebRTC Signaling Server Ayame

GitHub tag (latest SemVer) License Actions Status

About Shiguredo's open source software

We will not respond to PRs or issues that have not been discussed on Discord. Also, Discord is only available in Japanese.

Please read https://github.com/shiguredo/oss/blob/master/README.en.md before use.

時雨堂のオープンソースソフトウェアについて

利用前に https://github.com/shiguredo/oss をお読みください。

WebRTC Signaling Server Ayame について

WebRTC Signaling Server Ayame は WebRTC 向けのシグナリングサーバです。

WebRTC の P2P でのみ動作します。また動作を 1 ルームを最大 2 名に制限することでコードを小さく保っています。

OpenAyame プロジェクトについて

OpenAyame は WebRTC Signaling Server Ayame をオープンソースとして公開し、 継続的に開発を行うことで WebRTC をより身近に、使いやすくするプロジェクトです。

詳細については下記をご確認ください。

OpenAyame プロジェクト

方針

  • シグナリングの仕様の破壊的変更を可能な限り行わない
  • Go のバージョンは定期的にアップデートを行う
  • 依存ライブラリは定期的にアップデートを行う

注意

  • Ayame は P2P にしか対応していません
  • Ayame は 1 ルーム最大 2 名までしか対応していません

使ってみる

Ayame を使ってみたい人は USE.md をお読みください。

Web SDK を使ってみる

Ayame Web SDK

Web SDK サンプルを使ってみる

Ayame Web SDK サンプル

仕組みの詳細を知りたい

Ayame の仕組みを知りたい人は OpenAyame/ayame-spec をお読みください。

Ayame Labo を使ってみる

Ayame 仕様と完全互換な STUN/TURN サーバやルーム認証を組み込んだ無料で利用可能なシグナリングサービスを時雨堂が提供しています。

Ayame Labo

ライセンス

Apache License 2.0

Copyright 2019-2026, Shiguredo Inc.

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.

Ayame 利用例

Documentation

Index

Constants

View Source 
const (
	KB = prometheus.KB
	MB = prometheus.MB

	MetricsKey = "webhook_metrics"
)

Variables

View Source 
var Version string

Functions

func InitLogger 

func InitLogger(config *Config) error

func NewLogger 

func NewLogger(config *Config, logFilename string, logDomain string) (*zerolog.Logger, error)

Types

type Config 

type Config struct {
	Debug bool `ini:"debug"`

	LogDir              string `ini:"log_dir"`
	LogName             string `ini:"log_name"`
	LogStdout           bool   `ini:"log_stdout"`
	LogRotateMaxSize    int    `ini:"log_rotate_max_size"`
	LogRotateMaxBackups int    `ini:"log_rotate_max_backups"`
	LogRotateMaxAge     int    `ini:"log_rotate_max_age"`
	LogRotateCompress   bool   `ini:"log_rotate_compress"`

	LogMessageKeyName   string `ini:"log_message_key_name"`
	LogTimestampKeyName string `ini:"log_timestamp_key_name"`

	SignalingLogName    string   `ini:"signaling_log_name"`
	SignalingLogFilters []string `ini:"signaling_log_filters"`

	DebugConsoleLog     bool `ini:"debug_console_log"`
	DebugConsoleLogJSON bool `ini:"debug_console_log_json"`

	TypeMessage bool `ini:"type_message"`

	ListenIPv4Address string `ini:"listen_ipv4_address"`
	ListenPortNumber  int32  `ini:"listen_port_number"`

	// socket の待ち受け時間
	WebSocketReadTimeoutSec int32 `ini:"websocket_read_timeout_sec"`
	// pong が送られてこないためタイムアウトにするまでの時間
	WebSocketPongTimeoutSec int32 `ini:"websocket_pong_timeout_sec"`
	// ping 送信の時間間隔
	WebSocketPingIntervalSec int32 `ini:"websocket_ping_interval_sec"`

	// シグナリングからコピーする WebSocket の HTTP ヘッダー名
	CopyWebSocketHeaderNames []string `ini:"copy_websocket_header_names"`

	AuthnWebhookURL      string `ini:"authn_webhook_url"`
	DisconnectWebhookURL string `ini:"disconnect_webhook_url"`

	WebhookLogName           string `ini:"webhook_log_name"`
	WebhookRequestTimeoutSec int32  `ini:"webhook_request_timeout_sec"`

	ListenPrometheusIPv4Address string `ini:"listen_prometheus_ipv4_address"`
	ListenPrometheusPortNumber  int32  `ini:"listen_prometheus_port_number"`
}

func NewConfig 

func NewConfig(configFilePath string) (*Config, error)

func (*Config) PrintConfig 

func (c *Config) PrintConfig()

type Metrics 

type Metrics struct {
	WebhookReqCnt   *prometheus.Metric
	WebhookReqDur   *prometheus.Metric
	WebhookResSz    *prometheus.Metric
	WebhookReqSz    *prometheus.Metric
	AuthnWebhookCnt *prometheus.Metric
}

func NewMetrics 

func NewMetrics() *Metrics

func (*Metrics) IncAuthnWebhookCnt 

func (m *Metrics) IncAuthnWebhookCnt(code, method, host, url string, allowed bool, reason string)

func (*Metrics) IncWebhookReqCnt 

func (m *Metrics) IncWebhookReqCnt(code, method, host, url string)

func (*Metrics) ObserveWebhookReqDur 

func (m *Metrics) ObserveWebhookReqDur(code, method, host, url string, elapsed float64)

func (*Metrics) ObserveWebhookReqSz 

func (m *Metrics) ObserveWebhookReqSz(code, method, host, url string, sz int64)

func (*Metrics) ObserveWebhookResSz 

func (m *Metrics) ObserveWebhookResSz(code, method, host, url string, sz int64)

type Server 

type Server struct {
	EchoPrometheus *echo.Echo
	Metrics        *Metrics

	http.Server
	// contains filtered or unexported fields
}

func NewServer 

func NewServer(config *Config) (*Server, error)

func (*Server) Start 

func (s *Server) Start(ctx context.Context) error

func (*Server) StartMatchServer 

func (s *Server) StartMatchServer(ctx context.Context) error

Source Files

View all Source files

Directories

Path Synopsis
cmd
ayame command

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.