From fed5324ce505c3725472af23757cd6659bb7139c Mon Sep 17 00:00:00 2001 From: Chris Date: Thu, 2 Nov 2017 16:23:41 -0500 Subject: Add some plugin docs (#7757) * add some plugin docs * one more comment * spacing * example simplification --- plugin/hooks.go | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'plugin/hooks.go') diff --git a/plugin/hooks.go b/plugin/hooks.go index c5daec45b..a40ac0e5c 100644 --- a/plugin/hooks.go +++ b/plugin/hooks.go @@ -7,8 +7,14 @@ import ( "net/http" ) +// Hooks represents an object that handles events for a plugin. Methods are likely to be added over +// time, and plugins are not expected to implement all of them. Instead, plugins are expected to +// implement a subset of them and pass an instance to plugin/rpcplugin.Main, which will take over +// execution of the process and add default behaviors for missing hooks. type Hooks interface { - // OnActivate is invoked when the plugin is activated. + // OnActivate is invoked when the plugin is activated. Implementations will usually want to save + // the api argument for later use. Loading configuration for the first time is also a commonly + // done here. OnActivate(API) error // OnDeactivate is invoked when the plugin is deactivated. This is the plugin's last chance to -- cgit v1.2.3-1-g7c22