tidyable

package
Version: v0.1.20 Latest Latest
Warning

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

Go to latest
Published: Sep 25, 2021 License: BSD-3-Clause Imports: 5 Imported by: 13

Documentation

Overview

Package tidyable defines an interface for services that can be requested to clean up transient resource use (such as logs or caches.)

Index

Constants

This section is empty.

Variables

View Source
var TidyableDesc rpc.InterfaceDesc = descTidyable

TidyableDesc describes the Tidyable interface.

Functions

This section is empty.

Types

type TidyableClientMethods

type TidyableClientMethods interface {
	// Request the implementing service to perform regularly scheduled cleanup
	//  actions such as shrinking caches or rolling logs immediately.
	TidyNow(*context.T, ...rpc.CallOpt) error
}

TidyableClientMethods is the client interface containing Tidyable methods.

Tidyable specifies that a service can be tidied.

type TidyableClientStub

type TidyableClientStub interface {
	TidyableClientMethods
}

TidyableClientStub embeds TidyableClientMethods and is a placeholder for additional management operations.

func TidyableClient

func TidyableClient(name string) TidyableClientStub

TidyableClient returns a client stub for Tidyable.

type TidyableServerMethods

type TidyableServerMethods interface {
	// Request the implementing service to perform regularly scheduled cleanup
	//  actions such as shrinking caches or rolling logs immediately.
	TidyNow(*context.T, rpc.ServerCall) error
}

TidyableServerMethods is the interface a server writer implements for Tidyable.

Tidyable specifies that a service can be tidied.

type TidyableServerStub

type TidyableServerStub interface {
	TidyableServerStubMethods
	// DescribeInterfaces the Tidyable interfaces.
	Describe__() []rpc.InterfaceDesc
}

TidyableServerStub adds universal methods to TidyableServerStubMethods.

func TidyableServer

func TidyableServer(impl TidyableServerMethods) TidyableServerStub

TidyableServer returns a server stub for Tidyable. It converts an implementation of TidyableServerMethods into an object that may be used by rpc.Server.

type TidyableServerStubMethods

type TidyableServerStubMethods TidyableServerMethods

TidyableServerStubMethods is the server interface containing Tidyable methods, as expected by rpc.Server. There is no difference between this interface and TidyableServerMethods since there are no streaming methods.

Source Files

Jump to

Keyboard shortcuts

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