ct_ctl_adopt(3CONTRACT)                                                                                                    ct_ctl_adopt(3CONTRACT)

NAME

       ct_ctl_adopt, ct_ctl_abandon, ct_ctl_newct, ct_ctl_ack, ct_ctl_qack - common contract control functions

SYNOPSIS

       cc [ flag... ] file... -D_LARGEFILE64_SOURCE -lcontract [ library... ]
       #include <libcontract.h>

       int ct_ctl_adopt(int fd);

       int ct_ctl_abandon(int fd);

       int ct_ctl_newct(int fd, uint64_t evid);

       int ct_ctl_ack(int fd, uint64_t evid);

       int ct_ctl_qack(int fd, uint64_t evid, int templatefd);

       These functions operate on contract control file descriptors obtained from the contract(4) file system.

       The  ct_ctl_adopt()  function adopts the contract referenced by the file descriptor fd. After a successful call to ct_ctl_adopt(), the con-
       tract is owned by the calling process and any events in that contract's event queue are appended to the process's bundle of the appropriate
       type.

       The  ct_ctl_abandon()  function abandons the contract referenced by the file descriptor fd. After a successful call to ct_ctl_abandon() the
       process no longer owns the contract, any events sent by that contract are automatically removed from the process's bundle, and any critical
       events  on the contract's event queue are automatically acknowledged. Depending on its type and terms, the contract will either be orphaned
       or destroyed.

       The ct_ctl_ack() function acknowledges the critical event specified byevid. If the event corresponds to an exit  negotiation,  ct_ctl_ack()
       also indicates that the caller is prepared for the system to proceed with the referenced reconfiguration.

       The ct_ctl_qack() function requests a new quantum of time for the negotiation specified by the event ID evid.

       The  ct_ctl_newct()  function  instructs the contract specified by the file descriptor fd that when the current exit negotiation completes,
       another contract with the terms provided by the template specified by templatefd should be automatically written.

       Upon successful completion, ct_ctl_adopt(), ct_ctl_abandon(), ct_ctl_newct(), ct_ctl_ack(), and ct_ctl_qack()  return  0.  Otherwise,  they
       return a non-zero error value.

       The ct_ctl_adopt() function will fail if:

       EBUSY           The contract is in the owned state.

       EINVAL          The contract was not inherited by the caller's process contract or was created by a process in a different zone.

       The ct_ctl_abandon(), ct_ctl_newct(), ct_ctl_ack(), and ct_ctl_qack() functions will fail if:

       EBUSY           The contract does not belong to the calling process.

       The ct_ctl_newct() and ct_ctl_qack() functions will fail if:

       ESRCH           The event ID specified by evid does not correspond to an unacknowledged negotiation event.

       The ct_ctl_newct() function will fail if:

       EINVAL          The file descriptor specified by fd was not a valid template file descriptor.

       The ct_ctl_ack() function will fail if:

       ESRCH           The event ID specified by evid does not correspond to an unacknowledged critical event.

       The ct_ctl_qack() function will fail if:

       ERANGE          The maximum amount of time has been requested.

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE         |      ATTRIBUTE VALUE        |
       +-----------------------------+-----------------------------+
       |Interface Stability          |Evolving                     |
       +-----------------------------+-----------------------------+
       |MT-Level                     |Safe                         |
       +-----------------------------+-----------------------------+

       libcontract(3LIB), contract(4), attributes(5), lfcompile(5)

                                                                    22 Aug 2005                                            ct_ctl_adopt(3CONTRACT)