client

package

v0.0.0-...-ced3753 Latest Latest Go to latest Published: Jan 28, 2024 License: MIT Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/opencl-go/simulator-client

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Client
- func NewClient(address string) (*Client, error)
type Devices
- func (devices *Devices) Create(ctx context.Context) (uintptr, error)
- func (devices *Devices) Delete(ctx context.Context, id uintptr) error
type Platform
- func (platform *Platform) PrepareExtensionFunction(ctx context.Context) (string, uintptr, error)
- func (platform *Platform) ReleaseExtensionFunction(ctx context.Context, name string) error

Constants ¶

View Source

const (
	// PlatformServerAddressInfo is the PlatformInfoName that shall hold the server address of the simulator.
	// This is a forward from the grpc interface, so that the user of this package doesn't additionally have to
	// import the grpc package, just for this constant.
	PlatformServerAddressInfo = sim.PlatformServerAddressInfo
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Client ¶

type Client struct {
	// contains filtered or unexported fields
}

Client represents the simulator client, to be used in tests.

func NewClient ¶

func NewClient(address string) (*Client, error)

NewClient attempts to connect to the given address. Retrieve the value of the address by querying the OpenCL platform for the PlatformServerAddressInfo string.

func (*Client) Devices ¶

func (client *Client) Devices() *Devices

Devices is the accessor for device-specific interaction.

func (*Client) Disconnect ¶

func (client *Client) Disconnect()

Disconnect shuts down the connection.

func (*Client) Platform ¶

func (client *Client) Platform() *Platform

Platform is the accessor for platform-specific interaction.

type Devices ¶

type Devices struct {
	// contains filtered or unexported fields
}

Devices represents interactions on the devices layer.

func (*Devices) Create ¶

func (devices *Devices) Create(ctx context.Context) (uintptr, error)

Create requests to create a new device. The returned value is the ID value of the created device. Use this function for any new test that you intend to run in parallel to others.

func (*Devices) Delete ¶

func (devices *Devices) Delete(ctx context.Context, id uintptr) error

Delete requests to remove a previously created device. Call this function at the end of the test, to ensure resources are removed.

type Platform ¶

type Platform struct {
	// contains filtered or unexported fields
}

Platform represents interactions on the platform layer.

func (*Platform) PrepareExtensionFunction ¶

func (platform *Platform) PrepareExtensionFunction(ctx context.Context) (string, uintptr, error)

PrepareExtensionFunction requests to prepare an extension function for testing. The returned value is the address value of the function pointer. Note that the simulator has a limited amount of functions to return.

func (*Platform) ReleaseExtensionFunction ¶

func (platform *Platform) ReleaseExtensionFunction(ctx context.Context, name string) error

ReleaseExtensionFunction requests to release a previously prepared extension function. Call this function at the end of the test, to ensure resources are removed.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL