Opens a single AG Access port, and returns a context handle.

DWORD adiOpenPort( unsigned drvid,
unsigned board,
unsigned stream,
unsigned timeslot,
unsigned mode,
DWORD userid,
CTAHD *ctahd )

drvid Driver ID returned by adiOpenDriver.

board AG board number as configured by agmon.

stream MVIP stream.

timeslot MVIP time slot.

mode Stream and slot selection mode; any combination of:
ADI_VOICE_INPUT
ADI_VOICE_OUTPUT
ADI_SIGNAL_INPUT
ADI_SIGNAL_OUTPUT
ADI_VOICE_DUPLEX
ADI_SIGNAL_DUPLEX
ADI_FULL_DUPLEX

userid User-specified value which is written into the ADI_EVENT userid field when AG Access generates an event on this context.

ctahd Context handle returned by adiOpenPort.

• SUCCESS
• ADIERR_CANNOT_CREATE_CHANNEL
  Out of resources on board.
• ADIERR_INVALID_QUEUEID
  drvid is invalid.
• CTAERR_BAD_ARGUMENT
  Invalid MVIP mode or ctahd is NULL.
• CTAERR_INVALID_BOARD
  Invalid board number; not configured by agmon.
• CTAERR_OUT_OF_MEMORY
  Host memory allocation failed.

• ADIEVN_OPENPORT_DONE
  This event is generated after all resources are allocated and initialized on the given AG board. The event value field contains the open port completion status. If the value is CTA_REASON_FINISHED, the port is successfully opened. The following errors can be returned in the event value field:
• CTAERR_BAD_ARGUMENT
  Invalid MVIP stream or timeslot.
• CTAERR_OUTPUT_ACTIVE
  The MVIP stream:timeslot is in use. Note: If the event value field is not CTA_REASON_FINISHED, the port failed to initialize. The resources associated with the returned ctahd are still allocated to the process. You must invoke adiClosePort to release the resources and invalidate the ctahd.

The application supplies a drvid which associates the newly opened port with an open AG driver. This association is used to send commands and detect waiting events on the port's behalf. See the "Opening Ports" section of the AG Access Developer's Manual for a complete description.

The board argument identifies a particular AG board. This identifier must correlate to a board ID in the AG configuration file. Refer to the AG configuration file keyword "Board" in the AG Access Installation Manual.

adiOpenPort attaches the open port to a context, and returns a ctahd (context handle) for the application to use to access the associated port.

The MVIP stream, timeslot, and mode are discussed in detail the Application Development chapter of the AG Access Developer's Manual.

The userid is written into the ADI_EVENT userid field whenever AG Access generates an event for the application. The application can use this field to correlate the event with the appropriate context.

adiOpenDriver, adiFetchAndProcess, adiClosePort, adiStartProtocol

 
int myOpenPort( unsigned drvid, unsigned board,
                unsigned stream, unsigned timeslot, CTAHD *ctahd )
{
    ADI_EVENT event;

    if( adiOpenPort( drvid, board, stream, timeslot,
                     ADI_FULL_DUPLEX, 0, ctahd ) != SUCCESS )
        return MYFAILURE;

    do 
    {
        myGetEvent( &event );           /* see adiFetchAndProcess example */
    } while( event.id != ADIEVN_OPENPORT_DONE );

    if( event.value != CTA_REASON_FINISHED )
        return MYFAILURE;
    return SUCCESS;
}