Synopsis

void MiamiPanelAddInterface(
         LONG unit,
         STRPTR name,
         LONG state,
         LONG ontime,
         STRPTR speed );

Function

Add an interface to the panel's displayed interface list.

Inputs

unit   - Interface unit identifier.
name   - Interface name.
state  - Initial interface state flags.
ontime - Initial online-time reference value.
speed  - Initial speed text.

Notes

The function waits until the command message is processed,
but does not report whether the interface object was created.
The name and speed pointers must remain valid until the call
returns.

See also

MiamiPanelDelInterface() MiamiPanelSetInterfaceState()

Synopsis

void MiamiPanelCleanup();

Function

Request panel shutdown and wait for the panel process to finish.

Notes

The request is delivered through the panel command port. The
function does not report a failure if no command can be sent.

See also

MiamiPanelInit() MiamiPanelKill()

Synopsis

void MiamiPanelDelInterface(
         LONG unit );

Function

Request removal of an interface from the panel.

Inputs

unit - Interface unit identifier.

Notes

The command is queued without waiting for its completion.

See also

MiamiPanelAddInterface()

Synopsis

void MiamiPanelEvent(
         ULONG sigs );

Function

Reserved entry point for forwarding event signals to the panel.

Inputs

sigs - Signal mask; currently ignored.

Notes

This entry point has no effect in the current implementation.

Synopsis

void MiamiPanelGetCoord(
         LONG * xp,
         LONG * yp );

Function

Set both output coordinates to zero.

Inputs

xp - Pointer receiving the horizontal coordinate.
yp - Pointer receiving the vertical coordinate.

Notes

Both output pointers must be valid. No window position is queried.
This entry point is not implemented beyond initializing its outputs.

Synopsis

LONG MiamiPanelGetVersion();

Function

Return the MiamiPanel interface version identifier.

Result

Always returns 1.

Notes

The return value is not the library's version number.

Synopsis

void MiamiPanelInhibitRefresh(
         LONG val );

Function

Suspend or resume updates to the panel's interface group.

Inputs

val - Nonzero to increment the refresh-inhibition count; zero to
      decrement it if nonzero.

Notes

The first inhibition begins a MUI group change. The matching
decrement to zero completes it. Calls are queued; this function
does not wait for the panel to process them.

Synopsis

LONG MiamiPanelInit(
         IPTR synccb,
         IPTR asynccb,
         LONG flags,
         STRPTR font,
         STRPTR screen,
         LONG xo,
         LONG yo,
         IPTR sigbit );

Function

Start the MiamiPanel process and wait for its initialization result.

Inputs

synccb  - Synchronous callback supplied by the caller.
asynccb - Asynchronous callback supplied by the caller.
flags   - Initial panel display flags.
font    - Currently ignored.
screen  - Currently ignored.
xo      - Currently ignored.
yo      - Currently ignored.
sigbit  - Currently ignored.

Result

Nonzero if the panel process created its MUI application; zero if
initialization failed or another panel process was detected.

Notes

The call waits for a reply from the new process. The callback
pointers are retained by the library, not copied.

See also

MiamiPanelCleanup() MiamiPanelKill()

Synopsis

void MiamiPanelInterfaceReport(
         LONG unit,
         LONG rate,
         LONG now,
         LONG totalhi,
         ULONG totallo );

Function

Update the traffic and elapsed-time display for an interface.

Inputs

unit    - Interface unit identifier.
rate    - Rate value passed to the interface's rate display.
now     - Current time value; the displayed elapsed time is
          calculated relative to the stored ontime value.
totalhi - High 32 bits of the cumulative traffic counter.
totallo - Low 32 bits of the cumulative traffic counter.

Notes

A negative unit is ignored. Otherwise, the command is queued
without waiting for completion. The two traffic words are
presented together to the interface display.

Synopsis

ULONG MiamiPanelKill();

Function

Attempt to stop the panel process and reset panel process state.

Result

FALSE if the process semaphore can be obtained, or if it can be
obtained after requesting termination; TRUE otherwise.

Notes

If the panel application exists, the function requests its
termination and waits 200 ticks before testing the process semaphore.

Bugs

When the process remains active after the wait, this function
resets the process semaphore and may delete the command port while
that process still uses them. A TRUE result does not establish
that the process has terminated.

See also

MiamiPanelCleanup()

Synopsis

void MiamiPanelRefreshName(
         LONG unit,
         UBYTE * name );

Function

Change the displayed name of an interface.

Inputs

unit - Interface unit identifier.
name - Replacement name, valid until the call returns.

Notes

The function waits until the command message is processed.
It does not report whether the interface exists.

Synopsis

void MiamiPanelSetInterfaceSpeed(
         LONG unit,
         UBYTE * speed );

Function

Update the speed text displayed for an interface.

Inputs

unit  - Interface unit identifier.
speed - Speed text, valid until the call returns.

Notes

The function waits until the command message is processed.
It does not report whether the interface exists.

Synopsis

void MiamiPanelSetInterfaceState(
         LONG unit,
         LONG state,
         LONG ontime );

Function

Update the state and online-time reference of an interface.

Inputs

unit   - Interface unit identifier.
state  - Interface state flags.
ontime - Time reference used in elapsed-time calculation.

Notes

The command is queued without waiting for completion. No
change is made if the interface cannot be found.

Synopsis

void MiamiPanelToFront();

Function

Request that the panel be brought to the front.

Notes

The command is queued without waiting for its completion.