Documentation
¶
Index ¶
- Constants
- Variables
- type AuthenticationBackend
- type AuthenticationClient
- type AuthenticationOpts
- type BasicAuthenticationBackend
- type ConnectionType
- type CrudClient
- func (c *CrudClient) Create(resource string, value interface{}) error
- func (c *CrudClient) Delete(resource string, id string) error
- func (c *CrudClient) Get(resource string, id string, value interface{}) error
- func (c *CrudClient) List(resource string, values interface{}) error
- func (c *CrudClient) Update(resource string, id string, value interface{}) error
- type DefaultWSClientEventHandler
- type DefaultWSServerEventHandler
- type KeystoneAuthenticationBackend
- type NoAuthenticationBackend
- type PathPrefix
- type RestClient
- type Route
- type Server
- type User
- type WSAsyncClient
- type WSAsyncClientPool
- func (a *WSAsyncClientPool) AddEventHandler(h WSClientEventHandler, namespaces []string)
- func (a *WSAsyncClientPool) AddWSAsyncClient(client *WSAsyncClient)
- func (a *WSAsyncClientPool) BroadcastWSMessage(m *WSMessage)
- func (a *WSAsyncClientPool) ConnectAll()
- func (a *WSAsyncClientPool) DisconnectAll()
- func (a *WSAsyncClientPool) MasterClient() *WSAsyncClient
- func (a *WSAsyncClientPool) OnConnected(c *WSAsyncClient)
- func (a *WSAsyncClientPool) OnDisconnected(c *WSAsyncClient)
- func (a *WSAsyncClientPool) OnMessage(c *WSAsyncClient, m WSMessage)
- func (a *WSAsyncClientPool) SendWSMessageToMaster(m *WSMessage)
- type WSBulkMessage
- type WSClient
- type WSClientEventHandler
- type WSMessage
- type WSServer
- func (s *WSServer) AddEventHandler(h WSServerEventHandler, namespaces []string)
- func (s *WSServer) BroadcastWSMessage(msg *WSMessage)
- func (s *WSServer) GetClientsByType(clientType common.ServiceType) (clients []*WSClient)
- func (s *WSServer) ListenAndServe()
- func (s *WSServer) QueueBroadcastWSMessage(msg *WSMessage)
- func (s *WSServer) SendWSMessageTo(msg *WSMessage, host string) bool
- func (s *WSServer) Stop()
- type WSServerEventHandler
Constants ¶
View Source
const ( WilcardNamespace = "*" BulkMsgType = "BulkMessage" )
Variables ¶
Functions ¶
This section is empty.
Types ¶
type AuthenticationBackend ¶
type AuthenticationBackend interface {
Authenticate(username string, password string) (string, error)
Wrap(wrapped auth.AuthenticatedHandlerFunc) http.HandlerFunc
}
func NewAuthenticationBackendFromConfig ¶
func NewAuthenticationBackendFromConfig() (AuthenticationBackend, error)
type AuthenticationClient ¶
type AuthenticationClient struct {
Addr string
Port int
AuthToken string
// contains filtered or unexported fields
}
func NewAuthenticationClient ¶
func NewAuthenticationClient(addr string, port int, authOptions *AuthenticationOpts) *AuthenticationClient
func (*AuthenticationClient) Authenticate ¶
func (c *AuthenticationClient) Authenticate() error
func (*AuthenticationClient) Authenticated ¶
func (c *AuthenticationClient) Authenticated() bool
func (*AuthenticationClient) Cookie ¶
func (c *AuthenticationClient) Cookie() *http.Cookie
func (*AuthenticationClient) SetHeaders ¶
func (c *AuthenticationClient) SetHeaders(headers http.Header)
type BasicAuthenticationBackend ¶
type BasicAuthenticationBackend struct {
*auth.BasicAuth
}
func NewBasicAuthenticationBackend ¶ added in v0.5.0
func NewBasicAuthenticationBackend(file string) (*BasicAuthenticationBackend, error)
func NewBasicAuthenticationBackendFromConfig ¶
func NewBasicAuthenticationBackendFromConfig() (*BasicAuthenticationBackend, error)
func (*BasicAuthenticationBackend) Authenticate ¶
func (b *BasicAuthenticationBackend) Authenticate(username string, password string) (string, error)
func (*BasicAuthenticationBackend) Wrap ¶
func (b *BasicAuthenticationBackend) Wrap(wrapped auth.AuthenticatedHandlerFunc) http.HandlerFunc
type ConnectionType ¶ added in v0.12.0
type ConnectionType int
const ( // TCP connection TCP ConnectionType = 1 + iota // TLS secure connection TLS )
type CrudClient ¶
type CrudClient struct {
RestClient
Root string
}
func NewCrudClient ¶
func NewCrudClient(addr string, port int, authOpts *AuthenticationOpts, root string) *CrudClient
func (*CrudClient) Create ¶
func (c *CrudClient) Create(resource string, value interface{}) error
func (*CrudClient) Delete ¶
func (c *CrudClient) Delete(resource string, id string) error
func (*CrudClient) Get ¶
func (c *CrudClient) Get(resource string, id string, value interface{}) error
func (*CrudClient) List ¶
func (c *CrudClient) List(resource string, values interface{}) error
func (*CrudClient) Update ¶
func (c *CrudClient) Update(resource string, id string, value interface{}) error
type DefaultWSClientEventHandler ¶ added in v0.5.0
type DefaultWSClientEventHandler struct {
}
func (*DefaultWSClientEventHandler) OnConnected ¶ added in v0.5.0
func (d *DefaultWSClientEventHandler) OnConnected(c *WSAsyncClient)
func (*DefaultWSClientEventHandler) OnDisconnected ¶ added in v0.5.0
func (d *DefaultWSClientEventHandler) OnDisconnected(c *WSAsyncClient)
func (*DefaultWSClientEventHandler) OnMessage ¶ added in v0.5.0
func (d *DefaultWSClientEventHandler) OnMessage(c *WSAsyncClient, m WSMessage)
type DefaultWSServerEventHandler ¶ added in v0.5.0
type DefaultWSServerEventHandler struct {
}
func (*DefaultWSServerEventHandler) OnMessage ¶ added in v0.5.0
func (d *DefaultWSServerEventHandler) OnMessage(c *WSClient, m WSMessage)
func (*DefaultWSServerEventHandler) OnRegisterClient ¶ added in v0.5.0
func (d *DefaultWSServerEventHandler) OnRegisterClient(c *WSClient)
func (*DefaultWSServerEventHandler) OnUnregisterClient ¶ added in v0.5.0
func (d *DefaultWSServerEventHandler) OnUnregisterClient(c *WSClient)
type KeystoneAuthenticationBackend ¶
func NewKeystoneAuthenticationBackendFromConfig ¶
func NewKeystoneAuthenticationBackendFromConfig() *KeystoneAuthenticationBackend
func NewKeystoneBackend ¶
func NewKeystoneBackend(authURL string, tenant string, domain string) *KeystoneAuthenticationBackend
func (*KeystoneAuthenticationBackend) Authenticate ¶
func (b *KeystoneAuthenticationBackend) Authenticate(username string, password string) (string, error)
func (*KeystoneAuthenticationBackend) CheckUser ¶
func (b *KeystoneAuthenticationBackend) CheckUser(r *http.Request) (string, error)
func (*KeystoneAuthenticationBackend) Wrap ¶
func (b *KeystoneAuthenticationBackend) Wrap(wrapped auth.AuthenticatedHandlerFunc) http.HandlerFunc
type NoAuthenticationBackend ¶
type NoAuthenticationBackend struct {
}
func NewNoAuthenticationBackend ¶
func NewNoAuthenticationBackend() *NoAuthenticationBackend
func (*NoAuthenticationBackend) Authenticate ¶
func (h *NoAuthenticationBackend) Authenticate(username string, password string) (string, error)
func (*NoAuthenticationBackend) Wrap ¶
func (h *NoAuthenticationBackend) Wrap(wrapped auth.AuthenticatedHandlerFunc) http.HandlerFunc
type RestClient ¶
type RestClient struct {
// contains filtered or unexported fields
}
func NewRestClient ¶
func NewRestClient(addr string, port int, authOptions *AuthenticationOpts) *RestClient
type Route ¶
type Server ¶
type Server struct {
http.Server
Host string
ServiceType common.ServiceType
Router *mux.Router
Addr string
Port int
Auth AuthenticationBackend
CnxType ConnectionType
// contains filtered or unexported fields
}
func NewServer ¶
func NewServer(host string, serviceType common.ServiceType, addr string, port int, auth AuthenticationBackend) *Server
func NewServerFromConfig ¶
func NewServerFromConfig(serviceType common.ServiceType) (*Server, error)
func (*Server) HandleFunc ¶
type User ¶ added in v0.9.0
type WSAsyncClient ¶ added in v0.5.0
type WSAsyncClient struct {
sync.RWMutex
Host string
ClientType common.ServiceType
Addr string
Port int
Path string
AuthClient *AuthenticationClient
// contains filtered or unexported fields
}
func NewWSAsyncClient ¶ added in v0.5.0
func NewWSAsyncClient(host string, clientType common.ServiceType, addr string, port int, path string, authClient *AuthenticationClient) *WSAsyncClient
func NewWSAsyncClientFromConfig ¶ added in v0.5.0
func NewWSAsyncClientFromConfig(clientType common.ServiceType, addr string, port int, path string, authClient *AuthenticationClient) *WSAsyncClient
func (*WSAsyncClient) AddEventHandler ¶ added in v0.5.0
func (c *WSAsyncClient) AddEventHandler(h WSClientEventHandler, namespaces []string)
func (*WSAsyncClient) Connect ¶ added in v0.5.0
func (c *WSAsyncClient) Connect()
func (*WSAsyncClient) Disconnect ¶ added in v0.5.0
func (c *WSAsyncClient) Disconnect()
func (*WSAsyncClient) IsConnected ¶ added in v0.5.0
func (c *WSAsyncClient) IsConnected() bool
func (*WSAsyncClient) SendWSMessage ¶ added in v0.5.0
func (c *WSAsyncClient) SendWSMessage(m *WSMessage)
type WSAsyncClientPool ¶ added in v0.12.0
func NewWSAsyncClientPool ¶ added in v0.12.0
func NewWSAsyncClientPool() *WSAsyncClientPool
func (*WSAsyncClientPool) AddEventHandler ¶ added in v0.12.0
func (a *WSAsyncClientPool) AddEventHandler(h WSClientEventHandler, namespaces []string)
func (*WSAsyncClientPool) AddWSAsyncClient ¶ added in v0.12.0
func (a *WSAsyncClientPool) AddWSAsyncClient(client *WSAsyncClient)
func (*WSAsyncClientPool) BroadcastWSMessage ¶ added in v0.12.0
func (a *WSAsyncClientPool) BroadcastWSMessage(m *WSMessage)
func (*WSAsyncClientPool) ConnectAll ¶ added in v0.12.0
func (a *WSAsyncClientPool) ConnectAll()
func (*WSAsyncClientPool) DisconnectAll ¶ added in v0.12.0
func (a *WSAsyncClientPool) DisconnectAll()
func (*WSAsyncClientPool) MasterClient ¶ added in v0.12.0
func (a *WSAsyncClientPool) MasterClient() *WSAsyncClient
func (*WSAsyncClientPool) OnConnected ¶ added in v0.12.0
func (a *WSAsyncClientPool) OnConnected(c *WSAsyncClient)
func (*WSAsyncClientPool) OnDisconnected ¶ added in v0.12.0
func (a *WSAsyncClientPool) OnDisconnected(c *WSAsyncClient)
func (*WSAsyncClientPool) OnMessage ¶ added in v0.12.0
func (a *WSAsyncClientPool) OnMessage(c *WSAsyncClient, m WSMessage)
func (*WSAsyncClientPool) SendWSMessageToMaster ¶ added in v0.12.0
func (a *WSAsyncClientPool) SendWSMessageToMaster(m *WSMessage)
type WSBulkMessage ¶ added in v0.12.0
type WSBulkMessage []json.RawMessage
type WSClient ¶ added in v0.5.0
type WSClient struct {
Host string
ClientType common.ServiceType
// contains filtered or unexported fields
}
type WSClientEventHandler ¶ added in v0.5.0
type WSClientEventHandler interface {
OnMessage(c *WSAsyncClient, m WSMessage)
OnConnected(c *WSAsyncClient)
OnDisconnected(c *WSAsyncClient)
}
type WSMessage ¶ added in v0.5.0
type WSMessage struct {
Namespace string
Type string
UUID string `json:",omitempty"`
Obj *json.RawMessage
Status int
}
func NewWSMessage ¶ added in v0.5.0
func (*WSMessage) Reply ¶ added in v0.5.0
type WSServer ¶ added in v0.5.0
type WSServer struct {
sync.RWMutex
DefaultWSServerEventHandler
Server *Server
// contains filtered or unexported fields
}
func NewWSServer ¶ added in v0.5.0
func NewWSServerFromConfig ¶ added in v0.5.0
func (*WSServer) AddEventHandler ¶ added in v0.5.0
func (s *WSServer) AddEventHandler(h WSServerEventHandler, namespaces []string)
func (*WSServer) BroadcastWSMessage ¶ added in v0.5.0
func (*WSServer) GetClientsByType ¶ added in v0.5.0
func (s *WSServer) GetClientsByType(clientType common.ServiceType) (clients []*WSClient)
func (*WSServer) QueueBroadcastWSMessage ¶ added in v0.12.0
func (*WSServer) SendWSMessageTo ¶ added in v0.5.0
Source Files
¶
- auth.go
- basic.go
- client.go
- keystone.go
- noauth.go
- server.go
- tls.go
- wsclient.go
- wsserver.go
Click to show internal directories.
Click to hide internal directories.