DEFINE_CN defines a Connection Network (otherwise known as
a Virtual Routing Node or VRN). The verb provides the network qualified name
of the connection network along with its Transmission Group (TG) characteristics.
Also provided is a list of the names of the local ports that can
access this connection network.
DEFINE_CN can be used to redefine an existing Connection Network.
In particular, new ports can be added to the list of ports which
access the connection network by issuing another DEFINE_CN. (Ports
can be removed in the same way by issuing the DELETE_CN verb).
This verb is valid only at an end node, and not at a LEN node.
VCB
Structure |
 |
typedef struct define_cn
{
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 fqcn_name[17]; /* name of connection network */
CN_DEF_DATA def_data; /* CN defined data */
unsigned char port_name[8][8]; /* port names */
} DEFINE_CN;
|
typedef struct cn_def_data
{
unsigned char description[32]; /* resource description */
unsigned char reserve0[16]; /* reserved */
unsigned char num_ports; /* number of ports on CN */
unsigned char reserve1[16]; /* reserved */
TG_DEFINED_CHARS tg_chars; /* TG characteristics */
} CN_DEF_DATA;
|
typedef struct tg_defined_chars
{
unsigned char effect_cap; /* effective capacity */
unsigned char reserve1[5]; /* reserved */
unsigned char connect_cost; /* connection cost */
unsigned char byte_cost; /* byte cost */
unsigned char reserve2; /* reserved */
unsigned char security; /* security */
unsigned char prop_delay; /* propagation delay */
unsigned char modem_class; /* reserved */
unsigned char user_def_parm_1; /* user-defined parameter 1 */
unsigned char user_def_parm_2; /* user-defined parameter 2 */
unsigned char user_def_parm_3; /* user-defined parameter 3 */
} TG_DEFINED_CHARS;
|
Supplied
Parameters |
|
The application supplies the following parameters:
- opcode
AP_DEFINE_CN
- fqcn_name
Fully qualified name of the connection network.
The name is a 17-byte EBCDIC string, right-padded 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.
- def_data.description
A null-terminated text string (0-31 characters followed by
a null character) describing the connection network. This string
is for information only; it is stored in the node's configuration
file and returned on the QUERY_CN verb, but SNAplus2 does not make
any other use of it.
- def_data.num_ports
Number of ports included on this verb; each DEFINE_CN
verb can specify up to 8 ports. To define a CN with more than 8
ports, issue multiple DEFINE_CN verbs for the same CN name; the maximum
total number of ports on a CN is 239.
- def_data.tg_chars.effect_cap
Actual bits per second rate (line speed). The value
is encoded as a 1-byte floating point number, represented by the
formula 0.1 mmm * 2 eeeee where the bit representation
of the byte is b'eeeeemmm'. Each unit of effective capacity is equal
to 300 bits per second.
- def_data.tg_chars.connect_cost
Cost per connect time. Valid values are integer
values in the range 0-255,
where 0 is the lowest cost per connect time and 255 is
the highest.
- def_data.tg_chars.byte_cost
Cost per byte. Valid values are integer values in
the range 0-255, where 0 is
the lowest cost per byte and 255 is the highest.
- def_data.tg_chars.security
Security level of the network. Possible values are:
- AP_SEC_NONSECURE
No security.
- AP_SEC_PUBLIC_SWITCHED_NETWORK
Data is transmitted over a public switched network.
- AP_SEC_UNDERGROUND_CABLE
Data is transmitted over secure underground cable.
- AP_SEC_SECURE_CONDUIT
Data is transmitted over a line in a secure conduit
that is not guarded.
- AP_SEC_GUARDED_CONDUIT
Data is transmitted over a line in a conduit that
is protected against physical tapping.
- AP_SEC_ENCRYPTED
Data is encrypted before transmission over the line.
- AP_SEC_GUARDED_RADIATION
Data is transmitted over a line that is protected
against physical and radiation tapping.
- def_data.tg_chars.prop_delay
Propagation delay: the time that a signal takes
to travel the length of the link. Specify one of the following values,
according to the type of link:
- AP_PROP_DELAY_MINIMUM
Minimum propagation delay.
- AP_PROP_DELAY_LAN
Delay is less than 480 microseconds (typical for
a LAN).
- AP_PROP_DELAY_TELEPHONE
Delay is in the range 480-49,512 microseconds (typical
for a telephone network).
- AP_PROP_DELAY_PKT_SWITCHED_NET
Delay is in the range 49,512-245,760 microseconds
(typical for a packet-switched network).
- AP_PROP_DELAY_SATELLITE
Delay is greater than 245,760 microseconds (typical
for a satellite link).
- AP_PROP_DELAY_MAXIMUM
Maximum propagation delay.
- def_data.tg_chars.user_def_parm_1 through def_data.tg_chars.user_def_parm_3
User-defined parameters, which you can use to include other
TG characteristics not covered by the above parameters. Each of
these parameters must be set to a value in the range 0-255.
- port_name
Array of up to eight port names defined on the connection
network. Each port name is an 8-byte ASCII string, padded on the
right with spaces if the name is shorter than 8 bytes, and must
already have been defined by a DEFINE_PORT verb. Additional ports
may be defined on the Connection Network by issuing another DEFINE_CN
specifying the new port names.
Returned
Parameters: Successful Execution |
|
If the verb executes successfully, SNAplus2 returns the following parameter:
Returned
Parameters: Parameter Check |
|
If the verb does not execute because of a parameter error,
SNAplus2 returns the following parameters:
- primary_rc
AP_PARAMETER_CHECK
- secondary_rc
Possible values are:
- AP_DEF_LINK_INVALID_SECURITY
The security parameter was not set to one of the valid values.
- AP_EXCEEDS_MAX_ALLOWED
Adding the specified number of ports would exceed
the maximum total number of ports on a CN.
- AP_INVALID_CN_NAME
The fqcn_name parameter contained a character that was not valid
or was not in the correct format.
- AP_INVALID_NUM_PORTS_SPECIFIED
The num_ports parameter was not set to a valid value.
- AP_INVALID_PORT_NAME
One or more of the port names specified did not
match the name of a defined port.
- AP_INVALID_PORT_TYPE
One or more of the specified ports cannot be on
a CN because its DLC type is a point-to-point type (such as SDLC)
rather than a network type.
Appendix A “Common
Return Codes” lists further
secondary return codes associated with AP_PARAMETER_CHECK,
which are common to all NOF verbs.
Returned
Parameters: State Check |
|
If the verb does not execute because of a state error, SNAplus2
returns the following parameters:
- primary_rc
AP_STATE_CHECK
- secondary_rc
Possible values are:
- AP_PORT_ACTIVE
The specified port cannot be modified because it
is currently active.
Appendix A “Common
Return Codes” lists further
secondary return codes associated with AP_STATE_CHECK,
which are common to all NOF verbs.
Returned
Parameters: Function Not Supported |
|
If the verb does not execute successfully because the local
node is a LEN node, SNAplus2 returns the following parameters:
- primary_rc
- AP_FUNCTION_NOT_SUPPORTED
The local node is a LEN node. This verb is valid
only at an end node.
Returned
Parameters: Other Conditions |
|
Appendix A “Common
Return Codes” lists further
combinations of primary and secondary return codes that are common
to all NOF verbs.
Printable version
