go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/server/cron/default.go (about)

     1  // Copyright 2021 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package cron
    16  
    17  // Default is a dispatcher installed into the server when using NewModule or
    18  // NewModuleFromFlags.
    19  //
    20  // The module takes care of configuring this dispatcher based on the server
    21  // environment and module's options.
    22  //
    23  // You still need to register your handlers in it using RegisterHandler and
    24  // configure Cloud Scheduler jobs (or cron.yaml when running on Appengine) to
    25  // actually invoke them.
    26  var Default Dispatcher
    27  
    28  // RegisterHandler is a shortcut for Default.RegisterHandler.
    29  func RegisterHandler(id string, h Handler) {
    30  	Default.RegisterHandler(id, h)
    31  }