bstr_activity_break(3) — Subroutines

Name

bstr_activity_break − Defines a breakpoint in the Activity execution flow (VODB only).

Syntax

bstr_t_status   bstr_activity_break (
                                  bstr_t_reference   ∗activity,
                                  bstr_t_string      breakpoint,
                                  bstr_t_callback    ∗preamble,
                                  bstr_t_callback    ∗postamble,
                                  bstr_t_rcb         ∗control);

Description

The bstr_activity_break procedure allows the calling Activity execution to notify activity that the indicated breakpoint has been reached.

If breakpoint is set (that is, it is in the list value of the Activity set_break_points attribute), the Activity execution is suspended until a resume message is sent to the Activity, for the breakpoint on which it is suspended.

Two user-defined procedures can be automatically executed by the bstr_activity_break procedure. If specified, the preamble is called before the Activity execution is suspended, whereas the postamble is called before it is resumed.

If the breakpoint is not set, no actions are performed and the calling Activity execution is not suspended.

Arguments

activity
access: read
The reference to the Activity object for which the calling application wishes to act as the Activity execution.

breakpoint
access: read
Specifies the breakpoint on which the Activity execution is to be synchronized. Any user-defined or Application Management Services-defined breakpoint string can be indicated. The user-defined breakpoint string must not be longer than BSTR_C_BREAK_POINT_LEN, and must be different from the Application Management Services-defined breakpoints.

Constant Name	Breakpoint String
BSTR_C_INIT	INIT
BSTR_C_START	START
BSTR_C_SHUTDOWN	SHUTDOWN

preamble
access: read
The address of a bstr_t_callback type structure that specifies a user-defined preamble procedure and its input parameter. The preamble procedure is called just before the Activity execution is suspended at the breakpoint.

postamble
access: read
The address of a bstr_t_callback type structure that specifies a user-defined postamble procedure and its input parameter. The postamble procedure is called just before the Activity execution is resumed.

control
access: read
The address of an optional request control block. The following constraints apply:

•The mode field must be set to BSTR_C_SYNCHRONOUS

•The timeout field must be set to 0

•No callback routine can be specified.

Return Values

BSTR_S_ABORTED	Operation aborted
BSTR_S_BAD_PARAMETER	Bad parameter value
BSTR_S_BAD_REFERENCE	Bad reference
BSTR_S_COMMUNICATION_ERROR	Communication error
BSTR_S_FINISH	Request aborted by bstr_finish
BSTR_S_INTERNAL_ERROR	Internal error
BSTR_S_INTR	Operation interrupted
BSTR_S_INVALID_NAME	Invalid name
BSTR_S_INVALID_OPERATION	Invalid operation
BSTR_S_INVALID_RCB	Invalid Request Control Block
BSTR_S_INVALID_USAGE	Invalid reference usage
BSTR_S_NORMAL	Normal successful completion
BSTR_S_NOT_INITIALIZED	BASEstar Open not initialized
BSTR_S_NO_MEMORY	Insufficient virtual memory
BSTR_S_SERVER_NOT_REACHABLE	Server not reachable

Museum