ADC Home > Reference Library > Reference > Darwin > Kernel Framework Reference

 

IOUserClient

Inherits from:
Declared In:

Overview

Provides a basis for communication between client applications and I/O Kit objects.


Functions

exportObjectToClient
removeMappingForDescriptor

exportObjectToClient

public

virtual IOReturn exportObjectToClient(
    task_t task, 
    OSObject *obj,
    io_object_t *clientObj);
Parameters
task

The task.

obj

The object we want to export to the client.

clientObj

Returned value is the client's port name.

Discussion

Makes an arbitrary OSObject available to the client task.

removeMappingForDescriptor

public

IOMemoryMap * removeMappingForDescriptor(
    IOMemoryDescriptor *memory);
Parameters
memory

The memory descriptor instance previously returned by the implementation of clientMemoryForType().

Return Value

A reference to the first IOMemoryMap instance found in the list of mappings created by IOUserClient from that passed memory descriptor is returned, or zero if none exist. The caller should release this reference.

Discussion

Removes the first mapping created from the memory descriptor returned by clientMemoryForType() from IOUserClient's list of mappings. If such a mapping exists, it is retained and the reference currently held by IOUserClient is returned to the caller.

Structs and Unions

ExpansionData

protected

struct ExpansionData {
};
Discussion

This structure will be used to expand the capablilties of this class in the future.

Member Data

reserved

protected

ExpansionData * reserved;
Discussion

Reserved for future use. (Internal use only)


Did this document help you?
Yes: Tell us what works for you.
It’s good, but: Report typos, inaccuracies, and so forth.
It wasn’t helpful: Tell us what would have helped.

 

Last Updated: 2008-12-19