socket

Documentation

Index

• func Dial(ctx context.Context, socketName string, waitForSocket bool, ...) (*grpc.ClientConn, error)
• func Exists(name string) (bool, error)
• func IsRunning(ctx context.Context, path string) (bool, error)
• func Listen(ctx context.Context, processName, socketName string) (net.Listener, error)
• func Remove(listener net.Listener) error
• func RootDaemonPath(ctx context.Context) string
• func UserDaemonPath(ctx context.Context) string
• func WaitForSocket(ctx context.Context, path string, ttw time.Duration) error
• func WaitUntilRunning(ctx context.Context, path string) error
• func WaitUntilVanishes(name, path string, ttw time.Duration) error

Functions

func Dial

func Dial(ctx context.Context, socketName string, waitForSocket bool, opts ...grpc.DialOption) (*grpc.ClientConn, error)

Dial dials the given socket and returns the resulting connection.

func Exists

func Exists(name string) (bool, error)

Exists returns true if a socket is found with the given name, false otherwise. An error is returned if the state of the socket cannot be determined, or if the found entry is not a socket.

func IsRunning

func IsRunning(ctx context.Context, path string) (bool, error)

IsRunning makes an attempt to dial the given socket and returns true if that succeeds. If the attempt doesn't succeed, the method returns false. No error is returned when the failed attempt is caused by a non-existing socket.

func Listen

func Listen(ctx context.Context, processName, socketName string) (net.Listener, error)

Listen returns a listener for the given socket and returns the resulting connection.

func Remove

func Remove(listener net.Listener) error

Remove removes any representation of the socket from the filesystem.

func RootDaemonPath

func RootDaemonPath(ctx context.Context) string

RootDaemonPath is the path used when communicating to the root daemon process.

func UserDaemonPath

func UserDaemonPath(ctx context.Context) string

UserDaemonPath is the path used when communicating to the user daemon process.

func WaitForSocket

func WaitForSocket(ctx context.Context, path string, ttw time.Duration) error

WaitForSocket waits until the socket at the given path comes into existence and returns when that happens. The wait will be max ttw (time to wait) long.

func WaitUntilRunning

func WaitUntilRunning(ctx context.Context, path string) error

WaitUntilRunning waits until the socket at the given path comes into existence and a dial is successful and returns when that happens. The wait will be max ttw (time to wait) long.

func WaitUntilVanishes

func WaitUntilVanishes(name, path string, ttw time.Duration) error

WaitUntilVanishes waits until the socket at the given path is removed and returns when that happens. The wait will be max ttw (time to wait) long. An error is returned if that time is exceeded before the socket is removed.