mirror of
https://github.com/tailscale/tailscale.git
synced 2026-02-09 17:52:57 +01:00
3ec5be3f51
This file was never truly necessary and has never actually been used in the history of Tailscale's open source releases. A Brief History of AUTHORS files --- The AUTHORS file was a pattern developed at Google, originally for Chromium, then adopted by Go and a bunch of other projects. The problem was that Chromium originally had a copyright line only recognizing Google as the copyright holder. Because Google (and most open source projects) do not require copyright assignemnt for contributions, each contributor maintains their copyright. Some large corporate contributors then tried to add their own name to the copyright line in the LICENSE file or in file headers. This quickly becomes unwieldy, and puts a tremendous burden on anyone building on top of Chromium, since the license requires that they keep all copyright lines intact. The compromise was to create an AUTHORS file that would list all of the copyright holders. The LICENSE file and source file headers would then include that list by reference, listing the copyright holder as "The Chromium Authors". This also become cumbersome to simply keep the file up to date with a high rate of new contributors. Plus it's not always obvious who the copyright holder is. Sometimes it is the individual making the contribution, but many times it may be their employer. There is no way for the proejct maintainer to know. Eventually, Google changed their policy to no longer recommend trying to keep the AUTHORS file up to date proactively, and instead to only add to it when requested: https://opensource.google/docs/releasing/authors. They are also clear that: > Adding contributors to the AUTHORS file is entirely within the > project's discretion and has no implications for copyright ownership. It was primarily added to appease a small number of large contributors that insisted that they be recognized as copyright holders (which was entirely their right to do). But it's not truly necessary, and not even the most accurate way of identifying contributors and/or copyright holders. In practice, we've never added anyone to our AUTHORS file. It only lists Tailscale, so it's not really serving any purpose. It also causes confusion because Tailscalars put the "Tailscale Inc & AUTHORS" header in other open source repos which don't actually have an AUTHORS file, so it's ambiguous what that means. Instead, we just acknowledge that the contributors to Tailscale (whoever they are) are copyright holders for their individual contributions. We also have the benefit of using the DCO (developercertificate.org) which provides some additional certification of their right to make the contribution. The source file changes were purely mechanical with: git ls-files | xargs sed -i -e 's/\(Tailscale Inc &\) AUTHORS/\1 contributors/g' Updates #cleanup Change-Id: Ia101a4a3005adb9118051b3416f5a64a4a45987d Signed-off-by: Will Norris <will@tailscale.com>
61 lines
2.8 KiB
Go
61 lines
2.8 KiB
Go
// Copyright (c) Tailscale Inc & contributors
|
|
// SPDX-License-Identifier: BSD-3-Clause
|
|
|
|
package desktop
|
|
|
|
import (
|
|
"errors"
|
|
"runtime"
|
|
)
|
|
|
|
// ErrNotImplemented is returned by [NewSessionManager] when it is not
|
|
// implemented for the current GOOS.
|
|
var ErrNotImplemented = errors.New("not implemented for GOOS=" + runtime.GOOS)
|
|
|
|
// SessionInitCallback is a function that is called once per [Session].
|
|
// It returns an optional cleanup function that is called when the session
|
|
// is about to be destroyed, or nil if no cleanup is needed.
|
|
// It is not safe to call SessionManager methods from within the callback.
|
|
type SessionInitCallback func(session *Session) (cleanup func())
|
|
|
|
// SessionStateCallback is a function that reports the initial or updated
|
|
// state of a [Session], such as when it transitions between foreground and background.
|
|
// It is guaranteed to be called after all registered [SessionInitCallback] functions
|
|
// have completed, and before any cleanup functions are called for the same session.
|
|
// It is not safe to call SessionManager methods from within the callback.
|
|
type SessionStateCallback func(session *Session)
|
|
|
|
// SessionManager is an interface that provides access to desktop sessions on the current platform.
|
|
// It is safe for concurrent use.
|
|
type SessionManager interface {
|
|
// Init explicitly initializes the receiver.
|
|
// Unless the receiver is explicitly initialized, it will be lazily initialized
|
|
// on the first call to any other method.
|
|
// It is safe to call Init multiple times.
|
|
Init() error
|
|
|
|
// Sessions returns a session snapshot taken at the time of the call.
|
|
// Since sessions can be created or destroyed at any time, it may become
|
|
// outdated as soon as it is returned.
|
|
//
|
|
// It is primarily intended for logging and debugging.
|
|
// Prefer registering a [SessionInitCallback] or [SessionStateCallback]
|
|
// in contexts requiring stronger guarantees.
|
|
Sessions() (map[SessionID]*Session, error)
|
|
|
|
// RegisterInitCallback registers a [SessionInitCallback] that is called for each existing session
|
|
// and for each new session that is created, until the returned unregister function is called.
|
|
// If the specified [SessionInitCallback] returns a cleanup function, it is called when the session
|
|
// is about to be destroyed. The callback function is guaranteed to be called once and only once
|
|
// for each existing and new session.
|
|
RegisterInitCallback(cb SessionInitCallback) (unregister func(), err error)
|
|
|
|
// RegisterStateCallback registers a [SessionStateCallback] that is called for each existing session
|
|
// and every time the state of a session changes, until the returned unregister function is called.
|
|
RegisterStateCallback(cb SessionStateCallback) (unregister func(), err error)
|
|
|
|
// Close waits for all registered callbacks to complete
|
|
// and releases resources associated with the receiver.
|
|
Close() error
|
|
}
|