xref: /illumos-gate/usr/src/man/man3dat/dat_cr_query.3dat (revision 45ede40b2394db7967e59f19288fae9b62efd4aa)
te
This manual page is derived from the DAT/uDAPL 1.2 specification.
Portions Copyright (c) 2007, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
DAT_CR_QUERY 3DAT "Jul 16, 2004"
NAME
dat_cr_query - provide parameters of the Connection Request
SYNOPSIS

cc [ flag.\|.\|. ] file.\|.\|. -ldat [ library.\|.\|. ]
#include <dat/udat.h>

DAT_RETURN
 dat_cr_query (
 IN DAT_CR_HANDLE cr_handle,
 IN DAT_CR_PARAM_MASK cr_param_mask,
 OUT DAT_CR_PARAM *cr_param
 )
PARAMETERS
cr_handle

Handle for an instance of a Connection Request.

cr_param_mask

Mask for Connection Request parameters.

cr_param

Pointer to a Consumer-allocated structure that the Provider fills for Consumer-requested parameters.

DESCRIPTION

The dat_cr_query() function provides to the Consumer parameters of the Connection Request. The Consumer passes in a pointer to the Consumer-allocated structures for Connection Request parameters that the Provider fills.

The cr_param_mask parameter allows Consumers to specify which parameters to query. The Provider returns values for cr_param_mask requested parameters. The Provider can return values for any other parameters.

RETURN VALUES
DAT_SUCCESS

The operation was successful

DAT_INVALID_HANDLE

The cr_handle handle is invalid.

DAT_INVALID_PARAMETER

The cr_param_mask parameter is invalid.

USAGE

The Consumer uses dat_cr_query() to get information about requesting a remote Endpoint as well as a local Endpoint if it was allocated by the Provider for the arrived Connection Request. The local Endpoint is created if the Consumer used PSP with DAT_PSP_PROVIDER as the value for psp_flags. For the remote Endpoint, dat_cr_query() provides remote_ia_address and remote_port_qual. It also provides remote peer private_data and its size.

ATTRIBUTES

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

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard: uDAPL, 1.1, 1.2
MT-Level Safe
SEE ALSO

libdat(3LIB), attributes(5)