none
void rpc_string_binding_compose
(
unsigned_char_p_t string_object_uuid,
unsigned_char_p_t protseq,
unsigned_char_p_t netaddr,
unsigned_char_p_t endpoint,
unsigned_char_p_t network_options,
unsigned_char_p_t *string_binding,
unsigned32 *status
)
- Scope:
- Public - declared in rpc.idl
- Description:
-
This routine will combine the components of a string binding and
return a formatted string binding.
- Inputs:
-
- string_obj_uuid
- A string representation of an object UUID.
- protseq
- An RPC Protocol Sequence.
- netaddr
- A Network Address.
- endpoint
- An RPC Endpoint.
- network_options
- A string of Network Options.
- Inputs/outputs:
- none
- Outputs:
-
- string_binding
- A string representation of the binding rep data
structure.
- status
- A value indicating the status of the routine.
- rpc_s_ok
- The call was successful.
- rpc_s_invalid_binding
- RPC Protocol ID in binding handle was invalid.
- rpc_s_coding_error
-
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
- void
- Side effects:
- none
void rpc_binding_from_string_binding
(
unsigned_char_p_t string_binding,
rpc_binding_handle_t *binding_h,
unsigned32 *status
)
- Scope:
- Public - declared in rpc.idl
- Description:
-
This routine converts a string binding to a Binding Rep data structure.
It will strip the object UUID, RPC Protocol Sequence string, endpoint,
network address and network options out of the string binding provided.
A Binding Rep will then be allocated through the RPC Protocol Service
identified in the RPC Protocol Sequence. An RPC Address will be allocated
through the Network Address Family Extension Service identified in the
RPC Protocol Sequence. The common fields of the Binding Rep will be set
to defaults and the RPC Prtotcol Service will be called to initialize
the RPC Protocol Service-specific part of the Binding Rep.
If the string binding contains an endpoint, the addr_is_dynamic field
in the binding rep is set to false, indicating a well-known endpoint.
(This field is initialized to true in rpc__binding_alloc.)
- Inputs:
-
- string_binding
- A string representation of the binding rep data
structure.
- Inputs/outputs:
- none
- Outputs:
-
- binding_h
- The binding handle which points to the binding
rep data structure to be created.
- status
- A value indicating the status of the routine.
- rpc_s_ok
- The call was successful.
- uuid_s_invalid_string_uuid
- Object UUID in string binding was invalid.
- rpc_s_invalid_string_binding
- String binding was invalid.
- rpc_s_coding_error
-
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
- void
- Side effects:
- none
void rpc_binding_to_string_binding
(
rpc_binding_handle_t binding_h,
unsigned_char_p_t *string_binding,
unsigned32 *status
)
- Scope:
- Public - declared in rpc.idl
- Description:
-
This routine will convert a Binding Rep data structure to its string
represenation, which is called a "string binding". It will first convert
the object UUID contained in the Binding Rep to string format. The string
format of the Protocol Sequence ID contained in the RPC Address will be
looked up in the RPC Protocol Sequence ID table. It will the call the
appropriate Network Address Family Extension Service to return the
endpoint, network address and network options form the RPC Address in the
Binding Rep.
- Inputs:
-
- binding_h
- The binding handle which points to the binding
rep data structure to be converted.
- Inputs/outputs:
- none
- Outputs:
-
string_binding - A string representation of the binding rep data
structure.
- status A value indicating the status of the routine.
-
- rpc_s_ok
- The call was successful.
- rpc_s_invalid_binding
- RPC Protocol ID in binding handle was invalid.
- rpc_s_coding_error
-
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
- void
- Side effects:
-
none
void rpc_string_binding_parse
(
unsigned_char_p_t string_binding,
unsigned_char_p_t *string_object_uuid,
unsigned_char_p_t *protseq,
unsigned_char_p_t *netaddr,
unsigned_char_p_t *endpoint,
unsigned_char_p_t *network_options,
unsigned32 *status
)
- Scope:
- Public - declared in rpc.idl
- Description:
-
This routine will split the string binding provided into multiple
components.
- Inputs:
-
- string_binding
- A string representation of the binding rep data
structure.
- Inputs/outputs:
- none
- Outputs:
-
- string_obj_uuid
- A string representation of an object UUID.
- protseq
- An RPC Protocol Sequence.
- netaddr
- A Network Address.
- endpoint
- An RPC Endpoint.
- network_options
- A string of Network Options.
- status
- A value indicating the status of the routine.
- rpc_s_ok
- The call was successful.
- rpc_s_invalid_string_binding
- The string binding could not be parsed
- rpc_s_coding_error
-
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
- void
- Side effects:
- none
Inquire of protocol secvences
boolean32 rpc_network_is_protseq_valid
(
unsigned_char_p_t rpc_protseq;
unsigned32 *status;
)
- Scope:
- Public - declared in rpc.idl
- Description:
-
This routine determines whether the Common Communications Service
supports a given RPC Protocol Sequence.
- Inputs:
-
- rpc_protseq
- The RPC protocol sequence whose validity is to be
determined.
- Inputs/outputs:
- none
- Outputs:
-
- status
- The result of the operation. One of:
- rpc_s_ok
-
- rpc_s_coding_error
-
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
-
true if the protocol sequence is supported,
false if the protocol sequence is not supported
- Side effects:
- none
void rpc_server_inq_bindings
(
rpc_binding_vector_p_t *binding_vec,
unsigned32 *status
)
- Scope:
- PUBLIC - declared in rpc.idl
- Description:
-
Return the bindings for this server to which RPCs may be made.
Note that object UUIDs are not part of these bindings.
- Inputs:
- none
- Inputs/outputs:
- none
- Outputs:
-
- binding_vector
- The vector of valid bindings to this server.
- status
- The result of the operation. One of:
- rpc_s_ok
-
- rpc_s_no_bindings
-
- rpc_s_coding_error
-
- Implicit inputs:
- none
- Implicit outputs:
- none
- Function value:
- void
- Side effects:
- none
void rpc_server_listen
(
unsigned32 max_calls,
unsigned32 *status
)
- Scope:
- PUBLIC - declared in rpc.idl
- Description:
-
This routine begins listening to the network for RPC requests.
- Inputs:
-
- max_calls
- The maximum number of concurrent calls which this
server will process.
- Inputs/outputs:
- none
- Outputs:
-
- status
- The result of the operation. One of:
- rpc_s_ok
-
- rpc_s_already_listening
-
- rpc_s_no_protseqs_registered
-
- rpc_s_coding_error
-
- Implicit inputs:
- none
- Implicit outputs:
- none
- Function value:
- void
- Side effects:
- none
void rpc_server_use_all_protseqs
(
unsigned32 max_calls,
unsigned32 *status
)
- Scope:
- PUBLIC - declared in rpc.idl
- Description:
-
This routine tells the Common Communication Service to listen for RPCs
on all supported (by both the Common Communication Service and the
operating system) RPC Protocol Sequences.
- Inputs:
-
- max_calls
- The maximum number of concurrent calls which this
server will process.
- Inputs/outputs:
- none
- Outputs:
-
- status
- The result of the operation. One of:
- rpc_s_ok
-
- rpc_s_coding_error
-
- Implicit inputs:
- none
- Implicit outputs:
- none
- Function value:
- void
- Side effects:
- none
void rpc_network_inq_protseqs
(
rpc_protseq_vector_p_t *protseq_vec;
unsigned32 *status;
)
- Scope:
- Public - declared in rpc.idl
- Description:
-
Return all protocol sequences supported by both the Common
Communication Service and the operating system.
- Inputs:
- none
- Inputs/outputs:
- none
- Outputs:
-
- protseq_vec
- The vector of RPC protocol sequences supported by
this RPC runtime system.
- status
- The result of the operation. One of:
- rpc_s_ok
-
- rpc_s_no_protseqs
-
- rpc_s_no_memory
-
- rpc_s_coding_error
-
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
- void
- Side effects:
- none
void rpc_protseq_vector_free
(
rpc_protseq_vector_p_t *protseq_vector;
unsigned32 *status;
)
- Scope:
- Public - declared in rpc.idl
- Description:
-
This routine will free the RPC Protocol Sequence strings pointed to in
the vector and the vector itself.
Note: The service that allocates this vector (rpc_network_inq_protseqs())
mem alloc()'s the memory required for the vector in one large chunk.
We therefore don't have to play any games, we just free once
for the base vector pointer.
- Inputs:
- none
- Inputs/outputs:
-
- protseq_vec
- The vector of RPC protocol sequences to be freed.
- Outputs:
-
status - The result of the operation. One of:
- rpc_s_ok
-
- rpc_s_coding_error
-
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
- void
- Side effects:
- none
Manage interface information
void rpc_server_register_if
(
rpc_if_handle_t ifspec_h,
uuid_p_t mgr_type_uuid,
rpc_mgr_epv_t mgr_epv,
unsigned32 *status
)
- Scope:
- Public - declared in rpc.idl
- Description:
- See description of "rpc__server_register_if_int".
- Inputs:
- ifspec_h
- Pointer to the ifspec
- mgr_type_uuid
- The interface type (if any)
- mgr_epv
- The manager epv for this interface
- Inputs/outputs:
- none
- Outputs:
- status
- The result of the operation. One of:
- rpc_s_ok
-
- rpc_s_type_already_registered
-
- rpc_s_no_memory
-
- rpc_s_coding_error
-
- Implicit inputs:
- none
- Implicit outputs:
- none
- Function value:
- void
- Side effects:
- none
void rpc_if_inq_id
(
rpc_if_handle_t ifspec_h,
rpc_if_id_t *if_id,
unsigned32 *status
)
- Scope:
- Public - declared in rpc.idl
- Description:
-
Extract the interface id (UUID and version numbers) from the given
interface spec.
- Inputs:
-
- ifspec_h
- Pointer to the ifspec
- Inputs/outputs:
- none
- Outputs:
-
- if_id
- The interface id.
- status
- The result of the operation. One of:
- rpc_s_ok
-
- rpc_s_coding_error
-
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
- void
- Side effects:
- none
void rpc_if_id_vector_free
(
rpc_if_id_vector_p_t *if_id_vector,
unsigned32 *status
)
- Scope:
- Public - declared in rpc.idl
- Description:
-
Free the memory allocated for an rpc_if_id_vector_t.
- Inputs:
- none
- Inputs/outputs:
-
- if_id_vector
- The vector of interface id's to be freed.
- Outputs:
-
- status
- The result of the operation. One of:
- rpc_s_ok
-
- rpc_s_coding_error
-
- rpc_s_invalid_arg
-
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
- void
- Side effects:
- none
General Utility
void dce_error_inq_id
(
unsigned long status_to_convert;
unsigned char *error_text;
int *status;
)
- Scope:
- Public - declared in dce_error.h
- Description:
-
Returns a text string in a user provided buffer associated with a given
error status code. In the case of errors a text string will also be
returned indicating the nature of the error.
- Inputs:
-
- status_to_convert
- A DCE error status code to be converted to
text form.
- Inputs/outputs:
- None.
- Outputs:
-
- error_text
- A user provided buffer to hold the text
equivalent of status_to_convert or
a message indicating what error occurred.
- status
- The result of the operation. One of:
-
- 0
- success
- -1
- failure
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
- none
- Side effects:
- none
void rpc_string_free
(
unsigned_char_p_t *string,
unsigned32 *status
)
- Scope:
- Public - declared in rpc.idl
- Description:
-
This routine will free the memory allocated for a string data structure.
A NULL pointer will be returned.
- Inputs:
- none
- Inputs/outputs:
-
- string
- A pointer to the string pointer for the memory to
be freed.
- Outputs:
-
- status
- A value indicating the result of the routine.
- rpc_s_ok
- The call was successful.
- rpc_s_coding_error
-
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
- void
- Side effects:
- none
Manage UUIDs
void uuid_create_nil
(
uuid_t *uuid,
unsigned32 *status
)
- Scope:
- Public - declared in UUID.IDL
- Description:
-
Create a 'nil' uuid.
- Inputs:
- none
- Inputs/outputs:
- none
- Outputs:
-
- uuid
- A nil UUID
- status
- return status value
- uuid_s_ok
-
- uuid_s_coding_error
-
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
- void
- Side effects:
- none
void uuid_create
(
uuid_t *uuid,
unsigned32 *status
)
- Scope:
- Public - declared in UUID.IDL
- Description:
-
Create a new UUID. Note: we only know how to create the new
and improved UUIDs.
- Inputs:
- none
- Inputs/outputs:
- none
- Outputs:
-
- uuid
- A new UUID value
- status
- return status value
- uuid_s_ok
-
- uuid_s_coding_error
-
-
Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
- void
- Side effects:
- none
void uuid_from_string
(
unsigned_char_p_t uuid_string,
uuid_t *uuid,
unsigned32 *status
)
- Scope:
- Public - declared in UUID.IDL
- Description:
-
Decode a UUID from a printable string.
- Inputs:
-
- uuid_string
- The string UUID to be converted to a binary UUID
- Inputs/outputs:
- none
- Outputs:
-
- uuid
- The binary representation of the given UUID
- status
- return status value
- uuid_s_ok
-
- uuid_s_bad_version
-
- uuid_s_invalid_string_uuid
-
- uuid_s_coding_error
-
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
- void
- Side effects:
- none
void uuid_to_string
(
uuid_p_t uuid,
unsigned_char_p_t *uuid_string,
unsigned32 *status
)
- Scope:
- Public - declared in UUID.IDL
- Description:
-
Encode a UUID into a printable string.
- Inputs:
-
- uuid
- A binary UUID to be converted to a string UUID.
- Inputs/outputs:
- none
- Outputs:
-
- uuid_string
- The string representation of the given UUID.
- status
- return status value
- uuid_s_ok
-
- uuid_s_bad_version
-
- uuid_s_coding_error
-
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
- void
- Side effects:
- none
boolean32 uuid_is_nil
(
uuid_p_t uuid,
unsigned32 *status
)
- Scope:
- Public - declared in UUID.IDL
- Description:
-
Check to see if a given UUID is 'nil'.
- Inputs:
-
- uuid
- A UUID
- Inputs/outputs:
- none
- Outputs:
-
- status
- return status value
- uuid_s_ok
-
- uuid_s_bad_version
-
- uuid_s_coding_error
-
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
-
true if UUID is nil,
false if UUID is not nil
- Side effects:
- none
boolean32 uuid_equal
(
register uuid_p_t uuid1,
register uuid_p_t uuid2,
register unsigned32 *status
)
- Scope:
- Public - declared in UUID.IDL
- Description:
-
Compare two UUIDs.
- Inputs:
-
- uuid1
- The first UUID to compare
- uuid2
- The second UUID to compare
- Inputs/outputs:
- none
- Outputs:
-
- status
- return status value
- uuid_s_ok
-
- uuid_s_bad_version
-
- uuid_s_coding_error
-
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
-
true if UUID's are equal,
false if UUID's are not equal
- Side effects:
- none
signed32 uuid_compare
(
uuid_p_t uuid1,
uuid_p_t uuid2,
unsigned32 *status
)
- Scope:
- Public - declared in UUID.IDL
- Description:
-
Compare two UUID's "lexically"
If either of the two arguments is given as a NULL pointer, the other
argument will be compared to the nil uuid.
Note:
- lexical ordering is not temporal ordering!
- in the interest of keeping this routine short, I have
violated the coding convention that says all if/else
constructs shall have {}'s. There are a little million
return()'s in this routine. FWIW, the only {}'s that
are really required are the ones in the for() loop.
- Inputs:
-
- uuid1
- The first UUID to compare
- uuid2
- The second UUID to compare
- Inputs/outputs:
- none
- Outputs:
-
- status
- return status value
- uuid_s_ok
-
- uuid_s_bad_version
-
- uuid_s_coding_error
-
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
-
- uuid_order_t
-
- -1
- uuid1 is lexically before uuid2
- 1
- uuid1 is lexically after uuid2
- Side effects:
- none
unsigned16 uuid_hash
(
uuid_p_t uuid,
unsigned32 *status
)
- Scope:
- Public - declared in UUID.IDL
- Description:
-
Return a hash value for a given UUID.
Note: Since the length of a UUID is architecturally defined to be
128 bits (16 bytes), we have forgone using a '#defined'
length. In particular, since the 'loop' has been unrolled
(for performance) the length is by definition 'hard-coded'.
- Inputs:
-
- uuid
- A UUID for which a hash value is to be computed
- Inputs/outputs:
- none
- Outputs:
-
- status
- return status value
- uuid_s_ok
-
- uuid_s_bad_version
-
- uuid_s_coding_error
-
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
-
- hash_value
- The hash value computed from the UUID
- Side effects:
-
none
Find servers from a name service
void rpc_ns_binding_import_begin
(
unsigned32 entry_name_syntax,
unsigned_char_p_t entry_name,
rpc_if_handle_t if_spec,
uuid_p_t object_uuid,
rpc_ns_handle_t *import_context,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Create an import context for an interface and optionally an object.
- Inputs:
-
- entry_name_syntax
-
- entry_name
-
- if_spec
-
- object_uuid
-
- Inputs/outputs:
- none
- Outputs:
-
- import_context
-
- status
-
- Function value:
- void
void rpc_ns_binding_import_next
(
rpc_ns_handle_t import_context,
rpc_binding_handle_t *binding,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Look up an interface and optionally an object from a name-service
database and return a binding of a compatible server (if found).
- Inputs:
-
- import_context
-
- INPUT/Outputs:
- none
- Outputs:
-
- binding
-
- status
-
- Function value:
- void
void rpc_ns_binding_import_done
(
rpc_ns_handle_t *import_context,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Delete an import context.
- Inputs:
- none
- Inputs/outputs:
-
- import_context
-
- Outputs:
-
- status
-
- Function value:
- void
void rpc_ns_binding_inq_entry_name
(
rpc_binding_handle_t binding,
unsigned32 entry_name_syntax,
unsigned_char_p_t *entry_name,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Inquire the name of the name service entry from which a binding
was obtained.
- Inputs:
-
- binding
-
- entry_name_syntax
-
- Inputs/outputs:
- none
- Outputs:
-
- entry_name
-
- status
-
- Function value:
- void
void rpc_ns_binding_lookup_begin
(
unsigned32 entry_name_syntax,
unsigned_char_p_t entry_name,
rpc_if_handle_t if_spec,
uuid_p_t object_uuid,
unsigned32 binding_max_count,
rpc_ns_handle_t *lookup_context,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Start a search in the name service for a compatible binding.
- Inputs:
-
- entry_name_syntax
-
- entry_name
-
- if_spec
-
- object_uuid
-
- binding_max_count
-
- Inputs/outputs:
- none
- Outputs:
-
- lookup_context
-
- status
-
- Function value:
- void
void rpc_ns_binding_lookup_next
(
rpc_ns_handle_t lookup_context,
rpc_binding_vector_p_t *binding_vector,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Continue a search in the name service for a compatible binding.
- Inputs:
-
- lookup_context
-
- Inputs/outputs:
- none
- Outputs:
-
- binding_vector
-
- status
-
- Function value:
- void
void rpc_ns_binding_select
(
rpc_binding_vector_t *binding_vector,
rpc_binding_handle_t *binding,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Select a binding from among those returned in a lookup operation.
- Inputs:
- none
- Inputs/outputs:
-
- binding_vector
-
- Outputs:
- binding
-
- status
-
- Function value:
- void
void rpc_ns_binding_lookup_done
(
rpc_ns_handle_t *lookup_context,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Terminate a search in the name service for a compatible binding.
- Inputs:
- none
- Inputs/outputs:
-
- lookup_context
-
- Outputs:
- status
-
- Function value:
- void
Manage name service expirations
void rpc_ns_mgmt_inq_exp_age
(
unsigned32 *expiration_age,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
-
- Inputs:
- none
- Inputs/outputs:
- none
- Outputs:
- expiration_age
-
- status
-
- Function value:
- void
void rpc_ns_mgmt_set_exp_age
(
unsigned32 expiration_age,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Set the default name service local data expiration age.
- Inputs:
-
- expiration_age
-
- Inputs/outputs:
- none
- Outputs:
- status
-
- Function value:
- void
void rpc_ns_mgmt_handle_set_exp_age
(
rpc_ns_handle_t ns_handle,
unsigned32 expiration_age,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Inquire the default name service local data expiration age.
- Inputs:
-
- ns_handle
-
- expiration_age
-
- Inputs/outputs:
- none
- Outputs:
- status
-
- Function value:
- void
Manage name service entries
void rpc_ns_mgmt_entry_create
(
unsigned32 entry_name_syntax,
unsigned_char_p_t entry_name,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Create a name service entry.
- Inputs:
-
- entry_name_syntax
-
- enrty_name
-
- Inputs/outputs:
- none
- Outputs:
- status
-
- Function value:
- void
void rpc_ns_entry_object_inq_begin
(
unsigned32 entry_name_syntax,
unsigned_char_p_t entry_name,
rpc_ns_handle_t *inquiry_context,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Start a search for an object UUID in a given name service entry.
- Inputs:
-
- entry_name_syntax
-
- entry_name
-
- Inputs/outputs:
- none
- Outputs:
- inquiry_context
-
- status
-
- Function value:
- void
void rpc_ns_entry_object_inq_next
(
rpc_ns_handle_t inquiry_context,
uuid_t *object_uuid,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Continue a search for an object UUID in a given name service entry.
- Inputs:
-
- inquiry_context
-
- Inputs/outputs:
- none
- Outputs:
- object_uuid
-
- status
-
- Function value:
- void
void rpc_ns_entry_object_inq_done
(
rpc_ns_handle_t *inquiry_context,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Terminate a search for an object UUID in a given name service entry.
- Inputs:
- none
- Inputs/outputs:
-
- inquiry_context
-
- Outputs:
- status
-
- Function value:
- void
void rpc_ns_entry_expand_name
(
unsigned32 entry_name_syntax,
unsigned_char_p_t entry_name,
unsigned_char_p_t *expanded_name,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Expand a name service entry name.
- Inputs:
-
- entry_name_syntax
-
- entry_name
-
- Inputs/outputs:
- none
- Outputs:
- expanded_name
-
- status
-
- Function value:
- void
void rpc_ns_mgmt_entry_inq_if_ids
(
unsigned32 entry_name_syntax,
unsigned_char_p_t entry_name,
rpc_if_id_vector_p_t *if_id_vector,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Inquire the interface id's exported into a name service entry.
- Inputs:
-
- entry_name_syntax
-
- entry_name
-
- Inputs/outputs:
- none
- Outputs:
- if_id_vector
-
- status
-
- Function value:
- void
void rpc_ns_mgmt_binding_unexport
(
unsigned32 entry_name_syntax,
unsigned_char_p_t entry_name,
rpc_if_id_p_t if_id,
unsigned32 vers_option,
uuid_vector_p_t object_uuid_vector,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Unexport an interface and/or a set of object uuids. This routine differs
from rpc_ns_binding_unexport only in that access to the ifspec is not
required, and it can therefore be performed by management applications
on behalf of other servers whose interface id's are known.
- Inputs:
-
- entry_name_syntax
-
- entry_name
-
- if_id
-
- vers_option
-
- object_uuid_vector
-
- Inputs/outputs:
- none
- Outputs:
- status
-
- Function value:
- void
void rpc_ns_mgmt_entry_delete
(
unsigned32 entry_name_syntax,
unsigned_char_p_t entry_name,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Delete an entry from the name service database.
- Inputs:
-
- entry_name_syntax
-
- entry_name
-
- Inputs/outputs:
- none
- Outputs:
- status
-
- Function value:
- void
Manage name service groups
void rpc_ns_group_mbr_add
(
unsigned32 group_name_syntax,
unsigned_char_p_t group_name,
unsigned32 member_name_syntax,
unsigned_char_p_t member_name,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Add a member name to a service group in the name service.
- Inputs:
-
- group_name_syntax
-
- group_name
-
- member_name_syntax
-
- member_name
-
- Inputs/outputs:
- none
- Outputs:
- status
-
- Function value:
- void
void rpc_ns_group_mbr_inq_begin
(
unsigned32 group_name_syntax,
unsigned_char_p_t group_name,
unsigned32 member_name_syntax,
rpc_ns_handle_t *inquiry_context,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Start a search for a member with a given name service name in a
service group.
- Inputs:
-
- group_name_syntax
-
- group_name
-
- member_name_syntax
-
- Inputs/outputs:
- none
- Outputs:
- inquiry_context
-
- status
-
- Function value:
- void
void rpc_ns_group_mbr_inq_next
(
rpc_ns_handle_t inquiry_context,
unsigned_char_p_t *member_name,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Continue a search for a member with a given name service name in a
service group.
- Inputs:
-
- inquiry_context
-
- Inputs/outputs:
- none
- Outputs:
- member_name
-
- status
-
- Function value:
- void
void rpc_ns_group_mbr_inq_done
(
rpc_ns_handle_t *inquiry_context,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Terminate a search for a member with a given name service name in a
service group.
- Inputs:
- none
- Inputs/outputs:
-
- inquiry_context
-
- Outputs:
- status
-
- Function value:
- void
void rpc_ns_group_mbr_remove
(
unsigned32 group_name_syntax,
unsigned_char_p_t group_name,
unsigned32 member_name_syntax,
unsigned_char_p_t member_name,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Remove a member name from a service group in the name service.
- Inputs:
-
- group_name_syntax
-
- group_name
-
- member_name_syntax
-
- member_name
-
- Inputs/outputs:
- none
- Outputs:
- status
-
- Function value:
- void
void rpc_ns_group_delete
(
unsigned32 group_name_syntax,
unsigned_char_p_t group_name,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Delete a service group from the name service database.
- Inputs:
-
- group_name_syntax
-
- group_name
-
- Inputs/outputs:
- none
- Outputs:
- status
-
- Function value:
- void
Manage name service profiles
void rpc_ns_profile_elt_add
(
unsigned32 profile_name_syntax,
unsigned_char_p_t profile_name,
rpc_if_id_p_t if_id,
unsigned32 member_name_syntax,
unsigned_char_p_t member_name,
unsigned32 priority,
unsigned_char_p_t annotation,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Add an element to a profile. If necessary, creates the entry.
- Inputs:
-
- profile_name_syntax
-
- profile_name
-
- if_id
-
- member_name_syntax
-
- member_name
-
- priority
-
- annotation
-
- Inputs/outputs:
- none
- Outputs:
- status
-
- Function value:
- void
void rpc_ns_profile_elt_inq_begin
(
unsigned32 profile_name_syntax,
unsigned_char_p_t profile_name,
unsigned32 inquiry_type,
rpc_if_id_p_t if_id,
unsigned32 if_vers_option,
unsigned32 member_name_syntax,
unsigned_char_p_t member_name,
rpc_ns_handle_t *inquiry_context,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Create an inquiry context for viewing the elements in a profile.
- Inputs:
-
- profile_name_syntax
-
- profile_name
-
- inquiry_name
-
- if_id
-
- if_vers_option
-
- member_name_syntax
-
- member_name
-
- Inputs/outputs:
- none
- Outputs:
- inquiry_context
-
- status
-
- Function value:
- void
void rpc_ns_profile_elt_inq_next
(
rpc_ns_handle_t inquiry_context,
rpc_if_id_t *if_id,
unsigned_char_p_t *member_name,
unsigned32 *priority,
unsigned_char_p_t *annotation,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Return one element at a time from a profile.
- Inputs:
-
- inquiry_context
-
- Inputs/outputs:
- none
- Outputs:
- if_id
-
- member_name
-
- priority
-
- annotation
-
- status
-
- Function value:
- void
void rpc_ns_profile_elt_inq_done
(
rpc_ns_handle_t *inquiry_context,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Deletes the inquiry context for viewing the elements in a profile.
- Inputs:
- none
- Inputs/outputs:
-
- inquiry_context
-
- Outputs:
- status
-
- Function value:
- void
void rpc_ns_profile_elt_remove
(
unsigned32 profile_name_syntax,
unsigned_char_p_t profile_name,
rpc_if_id_p_t if_id,
unsigned32 member_name_syntax,
unsigned_char_p_t member_name,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Remove an element from a profile.
- Inputs:
-
- profile_name_syntax
-
- profile_name
-
- if_id
-
- member_name_syntax
-
- member_name
-
- Inputs/outputs:
- none
- Outputs:
- status
-
- Function value:
- void
void rpc_ns_profile_delete
(
unsigned32 profile_name_syntax,
unsigned_char_p_t profile_name,
unsigned32 *status
)
- Scope:
- Declared in RPC.IDL
- Description:
- Delete a configuration profile from the name service database.
- Inputs:
-
- profile_name_syntax
-
- profile_name
-
- Inputs/outputs:
- none
- Outputs:
- status
-
- Function value:
- void
Manage the client
void rpc_mgmt_inq_com_timeout
(
rpc_binding_handle_t binding_h,
unsigned32 timeout,
unsigned32 *status
)
- Scope:
- Public - declared in rpc.idl
- Description:
-
This is a Local management function that sets the RPC timeout for a
binding. The timeout value is a metric indicating the relative amount
of time retries to contact the server should be made. The value 10
indicates an unbounded wait. A zero value indicates no wait. Values 1-5
favor fast reponse time over correctness in determining whether the server
is alive. Values 6-9 favor correctness over response time. The RPC
Protocol Service identified by the RPC Protocol ID in the Binding Rep
will be notified that the Binding Rep has changed.
- Inputs:
-
- binding_h
- The binding handle which points to the binding
rep data structure to be modified.
- timeout
- The relative timeout value to be used when making
a connection to the location in the binding rep.
- 0
- rpc_c_binding_min_timeout
- 5
- rpc_c_binding_default_timeout
- 9
- rpc-c_binding_max_timeout
- 10
- rpc_c_binding_infinite_timeout
- Inputs/outputs:
- none
- Outputs:
-
- status
- A value indicating the status of the routine.
- rpc_s_ok
- The call was successful.
- rpc_s_invalid_binding
- RPC Protocol ID in binding handle was invalid.
- rpc_s_invalid_timeout
- Timeout value is not in the range -1 to 10
- rpc_s_coding_error
-
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
- void
- Side effects:
- none
void rpc_mgmt_set_com_timeout
(
rpc_binding_handle_t binding_h,
unsigned32 timeout,
unsigned32 *status
)
- Scope:
- Public - declared in rpc.idl
- Description:
-
This is a Local management function that sets the RPC timeout for a
binding. The timeout value is a metric indicating the relative amount
of time retries to contact the server should be made. The value 10
indicates an unbounded wait. A zero value indicates no wait. Values 1-5
favor fast reponse time over correctness in determining whether the server
is alive. Values 6-9 favor correctness over response time. The RPC
Protocol Service identified by the RPC Protocol ID in the Binding Rep
will be notified that the Binding Rep has changed.
- Inputs:
-
- binding_h
- The binding handle which points to the binding
rep data structure to be modified.
- timeout
- The relative timeout value to be used when making
a connection to the location in the binding rep.
- 0
- rpc_c_binding_min_timeout
- 5
- rpc_c_binding_default_timeout
- 9
- rpc-c_binding_max_timeout
- 10
- rpc_c_binding_infinite_timeout
- Inputs/outputs:
- none
- Outputs:
-
- status
- A value indicating the status of the routine.
- rpc_s_ok
- The call was successful.
- rpc_s_invalid_binding
- RPC Protocol ID in binding handle was invalid.
- rpc_s_invalid_timeout
- Timeout value is not in the range -1 to 10
- rpc_s_coding_error
-
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
- void
- Side effects:
- none
void rpc_mgmt_inq_dflt_protect_level
(
unsigned32 authn_protocol,
unsigned32 *authn_level,
unsigned32 *st
)
- Scope:
- Public - declared in rpcauth.idl
- Description:
-
Returns the default authentication level for an authentication service.
- Inputs:
-
- authn_protocol
- Desired authentication protocol.
- Inputs/outputs:
- none
- Outputs:
-
- authn_level
- Authentication level used by remote caller.
- status
- A value indicating the return status of the routine
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
- none
- Side effects:
- none
void rpc_mgmt_set_cancel_timeout
(
signed32 seconds,
unsigned32 *status
)
- Scope:
- Public - declared in rpc.idl
- Description:
-
This is a Local management function that sets the amount of time the
RPC runtime is to wait for a server to acknowledge a cancel before
orphaning the call. The application should specify to either wait
forever or to wait the length of the time specified in seconds. If the
value of seconds is 0 the remote procedure call is orphaned as soon as
a cancel is received by the server and control returns immediately to
the client application. The default is to wait forever for the call to
complete.
The value for the cancel timeout applies to all remote procedure calls
made in the current thread. A multi-threaded client that wishes to change
the default timeout value must call this routine in each thread of
execution.
- Inputs:
-
- seconds
- The number of seconds to wait for an acknowledgement.
- Inputs/outputs:
- none
- Outputs:
-
- status
- A value indicating the status of the routine.
- rpc_s_ok
- The call was successful.
- rpc_s_no_memory
-
- rpc_s_coding_error
-
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
- void
- Side effects:
- none
Manage local or remote applications
boolean32 rpc_mgmt_is_server_listening
(
rpc_binding_handle_t binding_h,
unsigned32 *status
)
- Scope:
- Internal
- Description:
-
This is the manager routine that returns true if it is ever executed to
indicate that the server is listening for remote calls.
- Inputs:
-
- binding_h
- The binding handle for this remote call.
- Inputs/outputs:
- none
- Outputs:
-
- status
- A value indicating the status of the routine.
- rpc_s_ok
- The call was successful.
- Implicit imputs:
- none
- Implicit outputs:
- none
- Function value:
-
true if server is listening,
false if server is not listening