Previous Page Contents Page Next Page

4.2 DIRECTORY_INDICATION

This indication is generated when an entry is added to or removed from the local directory database.

4.2.1 VCB Structure

typedef struct directory_indication
{
   AP_UINT16        opcode;              /* verb operation code              */
   unsigned char    reserv2;             /* reserved                         */
   unsigned char    format;              /* reserved                         */
   AP_UINT16        primary_rc;          /* primary return code              */
   AP_UINT32        secondary_rc;        /* secondary return code            */
   unsigned char    data_lost;           /* previous indication lost         */
   unsigned char    removed;             /* is entry being removed?          */
   unsigned char    resource_name[17];   /* resource name                    */
   unsigned char    invalid;             /* invalid entry being removed?     */
   AP_UINT16        resource_type;       /* resource type                    */
   unsigned char    parent_name[17];     /* parent resource name             */
   unsigned char    entry_type;          /* type of the directory entry      */
   AP_UINT16        parent_type;         /* parent resource type             */
   unsigned char    description[32];     /* resource description             */
   unsigned char    reserv3[16];         /* reserved                         */
   AP_UINT16        real_owning_cp_type;     /* CP type of real owner        */
   unsigned char    real_owning_cp_name[17]; /* CP name of real owner        */
   AP_UINT16        supplier_cp_type;        /* CP type of supplier          */
   unsigned char    supplier_cp_name[17];    /* CP name of supplier          */
   unsigned char    reserva;                 /* reserved                     */
} DIRECTORY_INDICATION;

4.2.2 Parameters

opcode

AP_DIRECTORY_INDICATION

primary_rc

AP_OK

data_lost

Specifies whether any previous directory indications have been lost. If SNAP-IX detects a condition that prevents it from sending an indication (for example an internal resource shortage), it indicates this by setting the data_lost parameter on the next indication after the condition has cleared. Possible values are:

AP_YES

One or more previous directory indications were lost. Later fields in this VCB may be set to zeros.

AP_NO

No previous directory indications were lost.

removed

Specifies whether the indicated resource has been removed from the directory or added to it. Possible values are:

AP_YES

The entry has been removed.

AP_NO

The entry has been added.

resource_name

Fully qualified name of the resource. The name is a 17-byte EBCDIC string, padded on the right with EBCDIC spaces. It consists of a network ID of up to 8 A-string characters, an EBCDIC dot (period) character, and a network name of up to 8 A-string characters.

invalid

When an end node registers its resources with a network node, new directory entries are added to the network node's directory database for these resources. If the database already contains an explicitly defined entry for one of these resources, but the entry does not match the registered resource, SNAP-IX removes the entry that is not valid and replaces it with the correct entry. This parameter is used to indicate whether the entry has been removed because it was not valid and has been replaced by the correct entry from the registered resource or because it was explicitly deleted. Possible values are:

AP_YES

The entry has been removed because it was incorrect.

AP_NO

The entry has been removed because it was explicitly deleted.

If the local node is not a network node, or if removed is set to AP_NO, this parameter is not used.

resource_type

Resource type. Possible values are:

AP_NNCP_RESOURCE

Network node.

AP_ENCP_RESOURCE

End node.

AP_LU_RESOURCE

LU.

parent_name

Fully qualified name of parent resource. If resource_type is AP_NNCP_RESOURCE, this is set to 17 binary zeros.

The name is a 17-byte EBCDIC string, padded on the right with EBCDIC spaces. It consists of a network ID of up to 8 A-string characters, an EBCDIC dot (period) character, and a network name of up to 8 A-string characters.

entry_type

Specifies the type of the directory entry. This is one of the following:

AP_HOME

Local resource.

AP_CACHE

Cached entry.

AP_REGISTER

Registered resource (NN only)

parent_type

Specifies the parent type of the resource being registered. If resource_type is AP_NNCP_RESOURCE, this parameter is not used. Possible values are:

AP_NNCP_RESOURCE

Network node.

AP_ENCP_RESOURCE

End node.

description

A null-terminated text string describing the resource, as specified in the definition of the resource.

real_owning_cp_type

This parameter applies only if the local node is a Network Node or a Branch Network Node; it is reserved otherwise.

Specifies whether the real CP that owns the resource identified by this directory entry is the parent resource or another node. This is one of the following:

AP_NONE

The real owner is the parent resource.

AP_ENCP_RESOURCE

The real owner is an end node that is not the parent resource. For example, if the resource is owned by an End Node in the domain of a Branch Network Node (BrNN), the directory of this BrNN's Network Node Server includes the BrNN as the parent resource, but the real owning CP is the End Node.

real_owning_cp_name

This parameter applies only if the local node is a Network Node or a Branch Network Node; it is reserved otherwise.

If the real_owning_cp_type parameter indicates that the real owner of the resource is not the parent, this parameter specifies the fully qualified name of the CP that owns the resource; otherwise it is reserved.

The name is a 17-byte EBCDIC string, padded on the right with EBCDIC spaces. It consists of a network ID of 1-8 A-string characters, an EBCDIC dot (period) character, and a network name of 1-8 A-string characters.

supplier_cp_type

This parameter applies only if the local node is a Network Node or a Branch Network Node; it is reserved otherwise.

Specifies whether this directory entry was registered by another node that is not the owning CP of the resource. This is one of the following:

AP_NONE

The directory entry was not registered, or was registered by its owning CP.

AP_ENCP_RESOURCE

The directory entry was registered by a node that is not its owning CP. For example, if the resource is owned by an End Node in the domain of a Branch Network Node (BrNN) that is itself in the domain of the local node, the BrNN is the supplier because it registers the resource with the local node, but the real owning CP is the End Node.

supplier_cp_name

This parameter applies only if the local node is a Network Node or a Branch Network Node; it is reserved otherwise.

If the supplier_cp_type parameter indicates that the directory entry was registered by a node that is not the owning resource, this parameter specifies the fully qualified name of the CP that supplied the registration; otherwise it is reserved.

The name is a 17-byte EBCDIC string, padded on the right with EBCDIC spaces. It consists of a network ID of 1-8 A-string characters, an EBCDIC dot (period) character, and a network name of 1-8 A-string characters.

Previous Page Contents Page Top of Page Next page