websocket

Documentation

Index

• func GetClient(ctx context.Context, instanceName string) (*client.Client, error)
• func GetConfig(instanceName string) (config.Config, error)
• func GetDefaultClient() (*client.Client, error)
• func New(ctx context.Context, config config.Config) (*client.Client, error)
• func NewClient(ctx context.Context, instanceName string) (*client.Client, error)

Functions

func GetClient

func GetClient(ctx context.Context, instanceName string) (*client.Client, error)

GetClient -> gets the existing created instance if it's already created... if it's not created, then it's being created

func GetConfig

func GetConfig(instanceName string) (config.Config, error)

func GetDefaultClient

func GetDefaultClient() (*client.Client, error)

GetDefaultClient -> it will return a new websocket client instance by taking the default configuration

func New

func New(
	ctx context.Context,
	config config.Config,
) (*client.Client, error)

New -> creates a new client based on the provided configuration

func NewClient

func NewClient(ctx context.Context, instanceName string) (*client.Client, error)

NewClient -> Generates a new instance based on the configuration! Multiple instances can be generated based on the same configuration