Museum

MBX_$CREATE_SERVER                Domain/OS                 MBX_$CREATE_SERVER


NAME
     mbx_$create_server - create a mailbox

SYNOPSIS (C)
     #include <apollo/base.h>
     #include <apollo/mbx.h>

     void mbx_$create_server(
          char *path_name,
          short &path_length,
          short &buffer_size,
          short &max_channels,
          void **mbx_handle,
          status_$t *status)

SYNOPSIS (Pascal)
     %include '/sys/ins/base.ins.pas';
     %include '/sys/ins/mbx.ins.pas';

     procedure mbx_$create_server(
          in path_name: univ mbx_$name_t;
          in path_length: integer;
          in buffer_size: integer;
          in max_channels: integer;
          out mbx_handle: univ_ptr;
          out status: status_$t);

SYNOPSIS (FORTRAN)
     %include '/sys/ins/base.ins.ftn'
     %include '/sys/ins/mbx.ins.ftn'

           integer*4 mbx_handle, status
           integer*2 path_length, buffer_size, max_channels
           character path_name*1023

           call mbx_$create_server(path_name, path_length, buffer_size,
          &                        max_channels, mbx_handle, status)

DESCRIPTION
     Mbx_$create_server creates a mailbox, and registers the calling process
     as the mailbox server.

     path_name
          The pathname where the mailbox should be created.  If an idle file
          already exists at path_name, its contents are lost.  If the file
          exists and is in use, mbx_$create_server fails.

     path_length
          The number of bytes in path_name.

     buffer_size
          The number of message bytes that the server and client can each
          buffer in a channel.  The value of buffer_size must be at least
          mbx_$min_chn_size, and should be large enough to hold the largest
          message passed between a server and a client.  Messages can be up to
          mbx_$rec_msg_max bytes long.

     max_channels
          The maximum number of channels the mailbox can support.
          Max_channels must be no greater than mbx_$chn_max.

     mbx_handle
          A handle for the new mailbox.

     status
          The completion status.