1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
|
// Copyright (C) 2022 Andrew Ayer
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
// OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
//
// Except as contained in this notice, the name(s) of the above copyright
// holders shall not be used in advertising or otherwise to promote the
// sale, use or other dealings in this Software without prior written
// authorization.
package listener // import "src.agwa.name/go-listener"
import (
"net"
"sync"
)
// A function that is called by [Open] or [OpenJSON] to create a [net.Listener] of
// a particular type. If called by Open, then the first argument is nil,
// and the second argument is the string passed to Open, with the listener
// type and colon character removed. If called by OpenJSON, the first argument
// is the JSON object passed to OpenJSON, and the second argument is empty.
//
// You only need to care about this if you are extending go-listener with
// your own custom listener types using [RegisterListenerType].
type OpenListenerFunc func(map[string]interface{}, string) (net.Listener, error)
var (
listenerTypes = make(map[string]OpenListenerFunc)
listenerTypesMu sync.RWMutex
)
// RegisterListenerType makes a listener type available by the provided name.
// Use this function to extend go-listener with your own custom listener types.
// See the documentation for [OpenListenerFunc] for details.
//
// If RegisterListenerType is called twice with the same name or if
// openListener is nil, it panics.
func RegisterListenerType(name string, openListener OpenListenerFunc) {
listenerTypesMu.Lock()
defer listenerTypesMu.Unlock()
if openListener == nil {
panic("RegisterListenerType: openListener is nil")
}
if _, isDup := listenerTypes[name]; isDup {
panic("RegisterListenerType: called twice for " + name)
}
listenerTypes[name] = openListener
}
func getOpenListenerFunc(listenerType string) OpenListenerFunc {
listenerTypesMu.RLock()
defer listenerTypesMu.RUnlock()
return listenerTypes[listenerType]
}
|