Unit Network
From Ultibo.org
Return to Unit Reference
Description
To be documented
Constants
To be documented
Type definitions
To be documented
Public variables
To be documented
Function declarations
Initialization functions
procedure NetworkInit;
Description: To be documented
| Note | To be documented |
|---|
function NetworkStart:LongWord;
Description: To be documented
| Note | To be documented |
|---|
function NetworkStop:LongWord;
Description: To be documented
| Note | To be documented |
|---|
function NetworkStartCompleted:Boolean;
Description: To be documented
| Return | Returns True if the network sub system has been started |
|---|
Network functions
function NetworkDeviceOpen(Network:PNetworkDevice):LongWord;
Description: To be documented
| Note | To be documented |
|---|
function NetworkDeviceClose(Network:PNetworkDevice):LongWord;
Description: To be documented
| Note | To be documented |
|---|
function NetworkDeviceRead(Network:PNetworkDevice; Buffer:Pointer; Size:LongWord; var Length:LongWord):LongWord;
Description: To be documented
| Note | To be documented |
|---|
function NetworkDeviceWrite(Network:PNetworkDevice; Buffer:Pointer; Size:LongWord; var Length:LongWord):LongWord;
Description: To be documented
| Note | To be documented |
|---|
function NetworkDeviceControl(Network:PNetworkDevice; Request:Integer; Argument1:LongWord; var Argument2:LongWord):LongWord;
Description: To be documented
| Note | To be documented |
|---|
function NetworkBufferAllocate(Network:PNetworkDevice; var Entry:PNetworkEntry):LongWord;
Description: Allocate a transmit buffer from the specified network device, the returned entry will include a buffer for writing data to as well as an offfset value to allow the driver data to be written to the start of the buffer. When the data has been copied to the buffer, pass the entry to NetworkBufferTransmit.
| Return | ERROR_SUCCESS if completed or another error code on failure |
|---|
function NetworkBufferRelease(Network:PNetworkDevice; Entry:PNetworkEntry):LongWord;
Description: Release a receive buffer to the specified network device, the entry must have been returned from NetworkBufferReceive
| Return | ERROR_SUCCESS if completed or another error code on failure |
|---|
function NetworkBufferReceive(Network:PNetworkDevice; var Entry:PNetworkEntry):LongWord;
Description: Receive a completed receive buffer from the specified network device. The returned entry will contain a one or more packets of data to read from. When the data has been processed pass the returned buffer to NetworkBufferRelease.
| Return | ERROR_SUCCESS if completed or another error code on failure |
|---|
function NetworkBufferTransmit(Network:PNetworkDevice; Entry:PNetworkEntry):LongWord;
Description: Transmit a completed transmit buffer to the specified network device. The entry must have been allocated using NetworkBufferAllocate.
| Return | ERROR_SUCCESS if completed or another error code on failure |
|---|
function NetworkDeviceSetState(Network:PNetworkDevice; State:LongWord):LongWord;
Description: Set the state of the specified network and send a notification
| Network | The network to set the state for |
|---|---|
| State | The new state to set and notify |
| Return | ERROR_SUCCESS if completed or another error code on failure |
function NetworkDeviceSetStatus(Network:PNetworkDevice; Status:LongWord):LongWord;
Description: Set the status of the specified network and send a notification
| Network | The network to set the status for |
|---|---|
| Status | The new status to set and notify |
| Return | ERROR_SUCCESS if completed or another error code on failure |
function NetworkDeviceCreate:PNetworkDevice;
Description: Create a new Network entry
| Return | Pointer to new Network entry or nil if network could not be created |
|---|
function NetworkDeviceCreateEx(Size:LongWord):PNetworkDevice;
Description: Create a new Network entry
| Size | Size in bytes to allocate for new network (Including the network entry) |
|---|---|
| Return | Pointer to new Network entry or nil if network could not be created |
function NetworkDeviceDestroy(Network:PNetworkDevice):LongWord;
Description: Destroy an existing Network entry
| Note | To be documented |
|---|
function NetworkDeviceRegister(Network:PNetworkDevice):LongWord;
Description: Register a new Network in the Network table
| Note | To be documented |
|---|
function NetworkDeviceDeregister(Network:PNetworkDevice):LongWord;
Description: Deregister a Network from the Network table
| Note | To be documented |
|---|
function NetworkDeviceFind(NetworkId:LongWord):PNetworkDevice;
Description: To be documented
| Note | To be documented |
|---|
function NetworkDeviceFindByName(const Name:String):PNetworkDevice; inline;
Description: To be documented
| Note | To be documented |
|---|
function NetworkDeviceFindByDescription(const Description:String):PNetworkDevice; inline;
Description: To be documented
| Note | To be documented |
|---|
function NetworkDeviceEnumerate(Callback:TNetworkEnumerate; Data:Pointer):LongWord;
Description: To be documented
| Note | To be documented |
|---|
function NetworkDeviceNotification(Network:PNetworkDevice; Callback:TNetworkNotification; Data:Pointer; Notification,Flags:LongWord):LongWord;
Description: To be documented
| Note | To be documented |
|---|
function NetworkEventAllocate(Callback:TNetworkEventCallback; Data:Pointer; Event:LongWord):PNetworkEvent;
Description: Create and Register a new Event entry in the Event table
| Note | To be documented |
|---|
function NetworkEventRelease(Event:PNetworkEvent):LongWord;
Description: Deregister and Destroy a Event from the Event table
| Note | To be documented |
|---|
function NetworkEventRegister(Callback:TNetworkEventCallback; Data:Pointer; Event:LongWord):THandle;
Description: Register a callback for one or more network events
| Note | To be documented |
|---|
function NetworkEventDeregister(Handle:THandle):LongWord;
Description: Deregister a network event callback
| Note | To be documented |
|---|
function NetworkEventNotify(Event:LongWord):LongWord;
Description: To be documented
| Note | To be documented |
|---|
RTL network functions
function SysHostGetName:String;
Description: To be documented
| Note | To be documented |
|---|
function SysHostSetName(const AName:String):Boolean;
Description: To be documented
| Note | To be documented |
|---|
function SysHostGetDomain:String;
Description: To be documented
| Note | To be documented |
|---|
function SysHostSetDomain(const ADomain:String):Boolean;
Description: To be documented
| Note | To be documented |
|---|
Network helper functions
function NetworkGetCount:LongWord; inline;
Description: Get the current network count
| Note | To be documented |
|---|
function NetworkDeviceCheck(Network:PNetworkDevice):PNetworkDevice;
Description: Check if the supplied Network is in the network table
| Note | To be documented |
|---|
function NetworkDeviceTypeToString(NetworkType:LongWord):String;
Description: To be documented
| Note | To be documented |
|---|
function NetworkDeviceStateToString(NetworkState:LongWord):String;
Description: To be documented
| Note | To be documented |
|---|
function NetworkDeviceStatusToString(NetworkStatus:LongWord):String;
Description: To be documented
| Note | To be documented |
|---|
function NetworkDeviceStateToNotification(State:LongWord):LongWord;
Description: Convert a Network state value into the notification code for device notifications
| Note | To be documented |
|---|
function NetworkDeviceStatusToNotification(Status:LongWord):LongWord;
Description: Convert a Network status value into the notification code for device notifications
| Note | To be documented |
|---|
function NetworkEventCheck(Event:PNetworkEvent):PNetworkEvent;
Description: Check if the supplied Event is in the event table
| Note | To be documented |
|---|
procedure NetworkLog(Level:LongWord; Network:PNetworkDevice; const AText:String);
Description: To be documented
| Note | To be documented |
|---|
procedure NetworkLogInfo(Network:PNetworkDevice; const AText:String);
Description: To be documented
| Note | To be documented |
|---|
procedure NetworkLogError(Network:PNetworkDevice; const AText:String);
Description: To be documented
| Note | To be documented |
|---|
procedure NetworkLogDebug(Network:PNetworkDevice; const AText:String);
Description: To be documented
| Note | To be documented |
|---|
function HardwareAddressToString(const AAddress:THardwareAddress):String;
Description: To be documented
| Note | To be documented |
|---|
function StringToHardwareAddress(const AAddress:String):THardwareAddress;
Description: To be documented
| Note | To be documented |
|---|
function CompareHardwareAddress(const AAddress1,AAddress2:THardwareAddress):Boolean;
Description: To be documented
| Note | To be documented |
|---|
function CompareHardwareDefault(const AAddress:THardwareAddress):Boolean;
Description: To be documented
| Note | To be documented |
|---|
function CompareHardwareBroadcast(const AAddress:THardwareAddress):Boolean;
Description: To be documented
| Note | To be documented |
|---|
function CompareHardwareMulticast(const AAddress:THardwareAddress):Boolean;
Description: To be documented
| Note | To be documented |
|---|
function AdapterTypeToString(AType:Word):String;
Description: To be documented
| Note | To be documented |
|---|
function AdapterModeToString(AMode:Word):String;
Description: To be documented
| Note | To be documented |
|---|
function AdapterConfigToString(AConfig:Word):String;
Description: To be documented
| Note | To be documented |
|---|
function AdapterStateToString(AState:Integer):String;
Description: To be documented
| Note | To be documented |
|---|
function AdapterStatusToString(AStatus:Integer):String;
Description: To be documented
| Note | To be documented |
|---|
function FrameTypeToString(AType:Word):String;
Description: To be documented
| Note | To be documented |
|---|
function MediaTypeToString(AType:Word):String;
Description: To be documented
| Note | To be documented |
|---|
function PacketTypetoString(AType:Word):String;
Description: To be documented
| Note | To be documented |
|---|
function ConfigTypeToString(AType:Word):String;
Description: To be documented
| Note | To be documented |
|---|
function ConfigCommandToString(ACommand:Word):String;
Description: To be documented
| Note | To be documented |
|---|
function AuthTypeToString(AType:Word):String;
Description: To be documented
| Note | To be documented |
|---|
function AuthCommandToString(ACommand:Word):String;
Description: To be documented
| Note | To be documented |
|---|
Return to Unit Reference
