ump_endpoint.h File Reference

UMP endpoint declarations. More...

Data Structures
struct	ump_endpoint
	Incoming UMP endpoint. More...

Functions
errval_t	ump_endpoint_init (struct ump_endpoint *ep, volatile void *buf, size_t bufsize)
	Initialise a new UMP endpoint. More...
void	ump_endpoint_destroy (struct ump_endpoint *ep)
	Destroy the local state associated with a given UMP endpoint.
errval_t	ump_endpoint_register (struct ump_endpoint *ep, struct waitset *ws, struct event_closure closure)
	Register an event handler to be notified when messages can be received. More...
errval_t	ump_endpoint_deregister (struct ump_endpoint *ep)
	Cancel an event registration made with ump_endpoint_register() More...
void	ump_endpoint_migrate (struct ump_endpoint *ep, struct waitset *ws)
	Migrate an event registration made with ump_endpoint_register() to a new waitset. More...

Detailed Description

UMP endpoint declarations.

Function Documentation

errval_t ump_endpoint_deregister

(

struct ump_endpoint *

ep

)

Cancel an event registration made with ump_endpoint_register()

Parameters

ep	UMP Endpoint

errval_t ump_endpoint_init	(	struct ump_endpoint *	ep,
		volatile void *	buf,
		size_t	bufsize
	)

Initialise a new UMP endpoint.

Parameters

ep	Storage for endpoint state
buf	Pointer to incoming message buffer
bufsize	Size of buf in bytes (must be multiple of UMP message size)

void ump_endpoint_migrate	(	struct ump_endpoint *	ep,
		struct waitset *	ws
	)

Migrate an event registration made with ump_endpoint_register() to a new waitset.

Parameters

ep	LMP Endpoint
ws	New waitset

errval_t ump_endpoint_register	(	struct ump_endpoint *	ep,
		struct waitset *	ws,
		struct event_closure	closure
	)

Register an event handler to be notified when messages can be received.

In the future, call the closure on the given waitset when it is likely that a message can be received on the endpoint. An endpoint may only be registered with a single event handler on a single waitset at any one time.

Parameters

ep	UMP endpoint
ws	Waitset
closure	Event handler