ADC Home > Reference Library > Reference > Hardware & Drivers > I/O Kit Framework Reference

 


IONetworkData.h

Include:

Path <IOKit/network/IONetworkData.h>

See Also:
Includes:

Overview

The IONetworkData class allows foruser space access to the network data buffer. Access level restrictions are available, as is a notification handler.



Classes

IONetworkData

An object that manages a fixed-size named buffer.



Enumerations


NetworkDataAccessTypes


Constants that describe access types.

enum { 
    kIONetworkDataAccessTypeRead = 0x01, 
    kIONetworkDataAccessTypeWrite = 0x02, 
    kIONetworkDataAccessTypeReset = 0x04, 
    kIONetworkDataAccessTypeSerialize = 0x08, 
    kIONetworkDataAccessTypeMask = 0xff 
};  
Constants
kIONetworkDataAccessTypeRead

Read access.

kIONetworkDataAccessTypeWrite

Write access.

kIONetworkDataAccessTypeReset

Reset access.

kIONetworkDataAccessTypeSerialize

Serialization access.


NetworkDataBufferTypes


The types of data buffers that can be managed by an IONetworkData object.

enum { 
    kIONetworkDataBufferTypeInternal = 0, 
    kIONetworkDataBufferTypeExternal, 
    kIONetworkDataBufferTypeNone 
};  
Constants
kIONetworkDataBufferTypeInternal

An internal data buffer allocated by the init() method.

kIONetworkDataBufferTypeExternal

An external (persistent) data buffer.

kIONetworkDataBufferTypeNone

No data buffer. The only useful action perfomed by an IONetworkData object with this buffer type is to call the access notification handler.

#defines


kIONetworkDataAccessTypes


A property of IONetworkData objects.

#define kIONetworkDataAccessTypes "Access Types" 
Discussion

The kIONetworkDataAccessTypes property is an OSNumber that describes the supported access types of an IONetworkData object.


kIONetworkDataBasicAccessTypes


#define kIONetworkDataBasicAccessTypes \ 
    (kIONetworkDataAccessTypeRead | kIONetworkDataAccessTypeSerialize) 
Discussion

The default access types supported by an IONetworkData object. Allow read() and serialize().


kIONetworkDataBytes


A property of IONetworkData objects.

#define kIONetworkDataBytes "Data" 
Discussion

The kIONetworkDataBytes property is an OSData that describes the data buffer of an IONetworkData object. This property is present only if kIONetworkDataAccessTypeSerialize access is supported.


kIONetworkDataSize


A property of IONetworkData objects.

#define kIONetworkDataSize "Size" 
Discussion

The kIONetworkDataSize property is an OSNumber that describes the size of the data buffer of an IONetworkData object.


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: 2009-02-23