service

Documentation

Overview

Package service implements the common utils function for daemon services.

To use the service package, import the package and its dependencies, as shown in the following example:

package main

import (
        _ "github.com/wabarc/wayback/ingress"
        "github.com/wabarc/wayback/service"
)

func main() {
        // Initialize services with configuration options and a context.
        opts := service.Options{}
        ctx := context.Background()
        err := service.Serve(ctx, opts)
        // ...
}

Index

• Constants
• Variables
• func ExcludeURL(urls []*url.URL, host string) (ex []*url.URL)
• func MatchURL(opts *config.Options, s string) (urls []*url.URL)
• func Register(srv config.Flag, action SetupFunc)
• func Serve(ctx context.Context, opts Options) (errs error)
• func Shutdown() (errs error)
• func UploadToDiscord(opts *config.Options, art reduxer.Artifact) (files []*discord.File)
• func UploadToSlack(client *slack.Client, opts *config.Options, art reduxer.Artifact, ...) (err error)
• func UploadToTelegram(opts *config.Options, art reduxer.Artifact, caption string) telegram.Album
• func Wayback(ctx context.Context, opts *config.Options, urls []*url.URL, do doFunc) error
• type Module
• type Option
  • func Config(c *config.Options) Option
  • func Pool(p *pooling.Pool) Option
  • func Publish(p *publish.Publish) Option
  • func Storage(s *storage.Storage) Option
• type Options
  • func ParseOptions(opts ...Option) (o Options)
• type Servicer
• type SetupFunc

Constants

const (
	CommandHelp     = "help"
	CommandMetrics  = "metrics"
	CommandPlayback = "playback"

	MsgWaybackRetrying = "wayback timeout, retrying."
	MsgWaybackTimeout  = "wayback timeout, please try later."
)

Variables

var ErrMissingURL = fmt.Errorf("URL no found")

Functions

func ExcludeURL

func ExcludeURL(urls []*url.URL, host string) (ex []*url.URL)

ExcludeURL removes URLs based on hostname; it is only available for multiple URLs. The URLs given should be de-duplicated advance.

func MatchURL

func MatchURL(opts *config.Options, s string) (urls []*url.URL)

MatchURL returns a slice string contains URLs extracted from the given string.

func Register

func Register(srv config.Flag, action SetupFunc)

Register registers a service instance's setup function and allows it to be called.

func Serve

func Serve(ctx context.Context, opts Options) (errs error)

Serve runs service in a separate goroutine.

func Shutdown

func Shutdown() (errs error)

Shutdown shuts down all services.

func UploadToDiscord

func UploadToDiscord(opts *config.Options, art reduxer.Artifact) (files []*discord.File)

UploadToDiscord composes files that share with Discord by a given artifact.

func UploadToSlack

func UploadToSlack(client *slack.Client, opts *config.Options, art reduxer.Artifact, channel, timestamp, caption string) (err error)

UploadToSlack upload files to channel and attach as a reply by the given artifact

func UploadToTelegram

func UploadToTelegram(opts *config.Options, art reduxer.Artifact, caption string) telegram.Album

UploadToTelegram composes files into an album by the given artifact.

func Wayback

func Wayback(ctx context.Context, opts *config.Options, urls []*url.URL, do doFunc) error

Wayback in a separate goroutine.

Types

type Module

type Module struct {
	Servicer

	Opts Options
	Flag config.Flag
}

Module is a struct embeds the Servicer interface and holds a pointer to Options.

type Option

type Option func(*Options)

Option is a function that modifies the provided Options instance.

func Config

func Config(c *config.Options) Option

Config returns an Option function that sets the Config field of Options.

func Pool

func Pool(p *pooling.Pool) Option

Pool returns an Option function that sets the Pool field of Options.

func Publish

func Publish(p *publish.Publish) Option

Publish returns an Option function that sets the Publish field of Options.

func Storage

func Storage(s *storage.Storage) Option

Storage returns an Option function that sets the Storage field of Options.

type Options

type Options struct {
	// Config holds the configuration options.
	Config *config.Options

	// Pool holds the connection pool to be used.
	Pool *pooling.Pool

	// Publish holds the publish service to be used.
	Publish *publish.Publish

	// Storage holds the storage service to be used.
	Storage *storage.Storage
}

Options represents the configuration for services.

func ParseOptions

func ParseOptions(opts ...Option) (o Options)

ParseOptions returns the Options instance with modifications applied using the provided Option functions.

type Servicer

type Servicer interface {
	// Serve serve a service.
	Serve() error

	// Shutdown shuts down service.
	Shutdown() error
}

Servicer is the interface that wraps Serve and Shutdown method.

Servicer serve several media platforms, e.g. Telegram, Discord, etc.

type SetupFunc

type SetupFunc func(context.Context, Options) (*Module, error)

SetupFunc is a function type that takes a pointer to a Options struct and returns a pointer to a Module struct.