Go to the source code of this file.
Functions | |
void | SCAGetReference (wchar_t *referenceName, SCAREF *referenceToken, int *compCode, int *reason) |
void | SCAGetReferences (wchar_t *referenceName, SCAREF **referenceTokens, int *num_targets, int *compCode, int *reason) |
void | SCAInvoke (SCAREF token, wchar_t *operationName, int inputMsgLen, void *inputMsg, int *outputMsgLen, void *outputMsg, int *compCode, int *reason) |
void | SCAPropertyBoolean (wchar_t *propertyName, char *value, int *num_values, int *compCode, int *reason) |
void | SCAPropertyByte (wchar_t *propertyName, int8_t *value, int *num_values, int *compCode, int *reason) |
void | SCAPropertyBytes (wchar_t *propertyName, int8_t **value, int *size, int *num_values, int *compCode, int *reason) |
void | SCAPropertyChar (wchar_t *propertyName, wchar_t *value, int *num_values, int *compCode, int *reason) |
void | SCAPropertyChars (wchar_t *propertyName, wchar_t **value, int *size, int *num_values, int *compCode, int *reason) |
void | SCAPropertyCChar (wchar_t *propertyName, char *value, int *num_values, int *compCode, int *reason) |
void | SCAPropertyCChars (wchar_t *propertyName, char **value, int *size, int *num_values, int *compCode, int *reason) |
void | SCAPropertyShort (wchar_t *propertyName, int16_t *value, int *num_values, int *compCode, int *reason) |
void | SCAPropertyInt (wchar_t *propertyName, int32_t *value, int *num_values, int *compCode, int *reason) |
void | SCAPropertyLong (wchar_t *propertyName, int64_t *value, int *num_values, int *compCode, int *reason) |
void | SCAPropertyFloat (wchar_t *propertyName, float *value, int *num_values, int *compCode, int *reason) |
void | SCAPropertyDouble (wchar_t *propertyName, double *value, int *num_values, int *compCode, int *reason) |
void | SCAPropertyString (wchar_t *propertyName, wchar_t **value, int *size, int *num_values, int *compCode, int *reason) |
void | SCAPropertyCString (wchar_t *propertyName, char **value, int *size, int *num_values, int *compCode, int *reason) |
void | SCAPropertyStruct (wchar_t *propertyName, void *value, int *num_values, int *compCode, int *reason) |
void | SCAPropertyDataObject (wchar_t *propertyName, DATAOBJECT *value, int *num_values, int *compCode, int *reason) |
void | SCAGetReplyMessage (SCAREF token, int *bufferLen, void *buffer, int *compCode, int *reason) |
void | SCAGetFaultMessage (SCAREF token, int *bufferLen, wchar_t **faultName, void *buffer, int *compCode, int *reason) |
void | SCASetFaultMessage (wchar_t *serviceName, wchar_t *operationName, wchar_t *faultName, int bufferLen, void *buffer, int *compCode, int *reason) |
void | SCASelf (wchar_t *serviceName, SCAREF *serviceToken, int *compCode, int *reason) |
void | SCAGetCallback (wchar_t *serviceName, SCAREF *serviceToken, int *compCode, int *reason) |
void | SCAReleaseCallback (SCAREF serviceToken, int *compCode, int *reason) |
void | SCAInvokeAsync (SCAREF token, wchar_t *operationName, int inputMsgLen, void *inputMsg, void(*handler)(short), int *compCode, int *reason) |
void | SCAInvokePoll (SCAREF token, wchar_t *operationName, int inputMsgLen, void *inputMsg, int *compCode, int *reason) |
void | SCACheckResponse (SCAREF token, short *responseType, int *compCode, int *reason) |
void | SCACancelInvoke (SCAREF token, int *compCode, int *reason) |
void | SCAEntryPoint (wchar_t *serviceURI, wchar_t *domainURI, SCAREF *serviceToken, int *compCode, int *reason) |
Copyright(C) OASIS(R) 2007,2010. All Rights Reserved. OASIS trademark, IPR and other policies apply.
This file contains the SCA API functions declarations for implementing SCA components and clients.
void SCACancelInvoke | ( | SCAREF | token, | |
int * | compCode, | |||
int * | reason | |||
) |
Tell the SCA runtime it has completed callback processing and the EndPointrReference can be released.
token | Token returned by prior SCALocate(), SCALocateMultiple(), SCASelf() or SCAGetCallback() call. | |
compCode |
| |
reason | SCA_PARAMETER_ERROR if there is no outstanding operation for this Reference. |
void SCACheckResponse | ( | SCAREF | token, | |
short * | responseType, | |||
int * | compCode, | |||
int * | reason | |||
) |
Determine if a response to a long running operation request has been received.
token | Token returned by prior SCALocate(), SCALocateMultiple(), SCASelf() or SCAGetCallback() call. | |
responseType | Type of response received. | |
compCode |
| |
reason | SCA_PARAMETER_ERROR if there is no outstanding operation for this Reference. |
void SCAEntryPoint | ( | wchar_t * | serviceURI, | |
wchar_t * | domainURI, | |||
SCAREF * | serviceToken, | |||
int * | compCode, | |||
int * | reason | |||
) |
Access a Service before invoking any operations of the Service.
serviceURI | URI of the Service to access. | |
domainURI | URI of the SCA domain. | |
serviceToken | Token to be used in subsequent SCAInvoke() calls. This will be NULL if the Service cannot be found. | |
compCode |
| |
reason | SCA_SERVICE_UNAVAILABLE if the domain does not exist of the service does not exist in the domain |
void SCAGetCallback | ( | wchar_t * | serviceName, | |
SCAREF * | serviceToken, | |||
int * | compCode, | |||
int * | reason | |||
) |
Initialize a Reference before invoking any operations of the Reference.
serviceName | Name of the Service to initialize. If a component only provides one service, this string can be empty. | |
serviceToken | Token to be used in subsequent SCAInvoke() calls. This will be NULL if serviceName is not defined for the component. | |
compCode |
| |
reason | SCA_SERVICE_UNAVAILABLE if client is no longer available in the domain. |
void SCAGetFaultMessage | ( | SCAREF | token, | |
int * | bufferLen, | |||
wchar_t ** | faultName, | |||
void * | buffer, | |||
int * | compCode, | |||
int * | reason | |||
) |
Retrieve the details of a business fault received in response to an operation invocation.
token | Token returned by prior SCAGetReference() or SCAGetReferences(), SCASelf() or SCAGetCallback() call. | |
bufferLen |
| |
faultName | Name of the business fault. | |
buffer | Fault message. | |
compCode |
| |
reason |
|
void SCAGetReference | ( | wchar_t * | referenceName, | |
SCAREF * | referenceToken, | |||
int * | compCode, | |||
int * | reason | |||
) |
Initialize a Reference before invoking any operations of the Reference.
referenceName | Name of the Reference to initialize. | |
referenceToken | Token to be used in subsequent SCAInvoke() calls. This will be NULL if referenceName is not defined for the component. | |
compCode |
| |
reason |
|
void SCAGetReferences | ( | wchar_t * | referenceName, | |
SCAREF ** | referenceTokens, | |||
int * | num_targets, | |||
int * | compCode, | |||
int * | reason | |||
) |
Initialize a Reference that might be bound to multiple Services before invoking any operations of the Reference.
referenceName | Name of the Reference to initialize. | |
referenceTokens | Array of tokens to be used in subsequent SCAInvoke() calls. These will all be NULL if referenceName is not defined for the component. Operations need to be invoked on each token in the array. | |
num_targets | Number of tokens returned in the array. | |
compCode |
| |
reason | SCA_SERVICE_UNAVAILABLE if no suitable service exists in the domain. |
void SCAGetReplyMessage | ( | SCAREF | token, | |
int * | bufferLen, | |||
void * | buffer, | |||
int * | compCode, | |||
int * | reason | |||
) |
Retrieve the reply message of an operation invocation if the length of the message exceeded the buffer size provided on SCAInvoke().
token | Token returned by prior SCAGetReference() or SCAGetReferences(), SCASelf() or SCAGetCallback() call. | |
bufferLen |
| |
buffer | Response message. | |
compCode |
| |
reason | SCA_DATA_TRUNCATED if the response data was truncated. |
void SCAInvoke | ( | SCAREF | token, | |
wchar_t * | operationName, | |||
int | inputMsgLen, | |||
void * | inputMsg, | |||
int * | outputMsgLen, | |||
void * | outputMsg, | |||
int * | compCode, | |||
int * | reason | |||
) |
Invoke an operation of an interface.
token | Token returned by prior SCAGetReference() or SCAGetReferences(), SCASelf() or SCAGetCallback() call. | |
operationName | Name of the operation to invoke. | |
inputMsgLen | Length of the request message buffer. | |
inputMsg | Request message. | |
outputMsgLen |
| |
outputMsg | Response message. | |
compCode |
| |
reason |
|
void SCAInvokeAsync | ( | SCAREF | token, | |
wchar_t * | operationName, | |||
int | inputMsgLen, | |||
void * | inputMsg, | |||
void(*)(short) | handler, | |||
int * | compCode, | |||
int * | reason | |||
) |
Invoke an operation of an interface.
token | Token returned by prior SCAGetReference() or SCAGetReferences(), SCASelf() or SCAGetCallback() call. | |
operationName | Name of the operation to invoke. | |
inputMsgLen | Length of the request message buffer. | |
inputMsg | Request message. | |
handler | Address of the function to handle the asynchronous response. | |
compCode |
| |
reason |
|
void SCAInvokePoll | ( | SCAREF | token, | |
wchar_t * | operationName, | |||
int | inputMsgLen, | |||
void * | inputMsg, | |||
int * | compCode, | |||
int * | reason | |||
) |
Invoke a long running operation of a Reference using the polling style.
token | Token returned by prior SCAGetReference() or SCAGetReferences(), SCASelf() or SCAGetCallback() call. | |
operationName | Name of the operation to invoke. | |
inputMsgLen | Length of the request message buffer. | |
inputMsg | Request message. | |
compCode |
| |
reason |
|
void SCAPropertyBoolean | ( | wchar_t * | propertyName, | |
char * | value, | |||
int * | num_values, | |||
int * | compCode, | |||
int * | reason | |||
) |
Get the configured value for a Property as a boolean.
propertyName | Name of the Property value to obtain. | |
value | Configured value(s) of the property. | |
num_values |
| |
compCode |
| |
reason |
|
void SCAPropertyByte | ( | wchar_t * | propertyName, | |
int8_t * | value, | |||
int * | num_values, | |||
int * | compCode, | |||
int * | reason | |||
) |
Get the configured value for a Property as a byte.
propertyName | Name of the Property value to obtain. | |
value | Configured value(s) of the property. | |
num_values |
| |
compCode |
| |
reason |
|
void SCAPropertyBytes | ( | wchar_t * | propertyName, | |
int8_t ** | value, | |||
int * | size, | |||
int * | num_values, | |||
int * | compCode, | |||
int * | reason | |||
) |
Get the configured value for a Property as an array of bytes.
propertyName | Name of the Property value to obtain. | |
value | Configured value(s) of the property. | |
size |
| |
num_values |
| |
compCode |
| |
reason |
|
void SCAPropertyCChar | ( | wchar_t * | propertyName, | |
char * | value, | |||
int * | num_values, | |||
int * | compCode, | |||
int * | reason | |||
) |
Get the configured value for a Property as a char.
propertyName | Name of the Property value to obtain. | |
value | Configured value(s) of the property. | |
num_values |
| |
compCode |
| |
reason |
|
void SCAPropertyCChars | ( | wchar_t * | propertyName, | |
char ** | value, | |||
int * | size, | |||
int * | num_values, | |||
int * | compCode, | |||
int * | reason | |||
) |
Get the configured value for a Property as an array of chars (not necessarily null terminated).
propertyName | Name of the Property value to obtain. | |
value | Configured value(s) of the property. | |
size |
| |
num_values |
| |
compCode |
| |
reason |
|
void SCAPropertyChar | ( | wchar_t * | propertyName, | |
wchar_t * | value, | |||
int * | num_values, | |||
int * | compCode, | |||
int * | reason | |||
) |
Get the configured value for a Property as a wide char.
propertyName | Name of the Property value to obtain. | |
value | Configured value(s) of the property. | |
num_values |
| |
compCode |
| |
reason |
|
void SCAPropertyChars | ( | wchar_t * | propertyName, | |
wchar_t ** | value, | |||
int * | size, | |||
int * | num_values, | |||
int * | compCode, | |||
int * | reason | |||
) |
Get the configured value for a Property as an array of wide chars (not necessarily null terminated).
propertyName | Name of the Property value to obtain. | |
value | Configured value(s) of the property. | |
size |
| |
num_values |
| |
compCode |
| |
reason |
|
void SCAPropertyCString | ( | wchar_t * | propertyName, | |
char ** | value, | |||
int * | size, | |||
int * | num_values, | |||
int * | compCode, | |||
int * | reason | |||
) |
Get the configured value for a Property as a string of chars.
propertyName | Name of the Property value to obtain. | |
value | Configured value(s) of the property. | |
size |
| |
num_values |
| |
compCode |
| |
reason |
|
void SCAPropertyDataObject | ( | wchar_t * | propertyName, | |
DATAOBJECT * | value, | |||
int * | num_values, | |||
int * | compCode, | |||
int * | reason | |||
) |
Get the configured value for a Property as a DataObject.
propertyName | Name of the Property value to obtain. | |
value | Configured value(s) of the property. | |
num_values |
| |
compCode |
| |
reason |
|
void SCAPropertyDouble | ( | wchar_t * | propertyName, | |
double * | value, | |||
int * | num_values, | |||
int * | compCode, | |||
int * | reason | |||
) |
Get the configured value for a Property as a double.
propertyName | Name of the Property value to obtain. | |
value | Configured value(s) of the property. | |
num_values |
| |
compCode |
| |
reason |
|
void SCAPropertyFloat | ( | wchar_t * | propertyName, | |
float * | value, | |||
int * | num_values, | |||
int * | compCode, | |||
int * | reason | |||
) |
Get the configured value for a Property as a float.
propertyName | Name of the Property value to obtain. | |
value | Configured value(s) of the property. | |
num_values |
| |
compCode |
| |
reason |
|
void SCAPropertyInt | ( | wchar_t * | propertyName, | |
int32_t * | value, | |||
int * | num_values, | |||
int * | compCode, | |||
int * | reason | |||
) |
Get the configured value for a Property as a long.
propertyName | Name of the Property value to obtain. | |
value | Configured value(s) of the property. | |
num_values |
| |
compCode |
| |
reason |
|
void SCAPropertyLong | ( | wchar_t * | propertyName, | |
int64_t * | value, | |||
int * | num_values, | |||
int * | compCode, | |||
int * | reason | |||
) |
Get the configured value for a Property as a long long.
propertyName | Name of the Property value to obtain. | |
value | Configured value(s) of the property. | |
num_values |
| |
compCode |
| |
reason |
|
void SCAPropertyShort | ( | wchar_t * | propertyName, | |
int16_t * | value, | |||
int * | num_values, | |||
int * | compCode, | |||
int * | reason | |||
) |
Get the configured value for a Property as a short.
propertyName | Name of the Property value to obtain. | |
value | Configured value(s) of the property. | |
num_values |
| |
compCode |
| |
reason |
|
void SCAPropertyString | ( | wchar_t * | propertyName, | |
wchar_t ** | value, | |||
int * | size, | |||
int * | num_values, | |||
int * | compCode, | |||
int * | reason | |||
) |
Get the configured value for a Property as a string of wide chars.
propertyName | Name of the Property value to obtain. | |
value | Configured value(s) of the property. | |
size |
| |
num_values |
| |
compCode |
| |
reason |
|
void SCAPropertyStruct | ( | wchar_t * | propertyName, | |
void * | value, | |||
int * | num_values, | |||
int * | compCode, | |||
int * | reason | |||
) |
Get the configured value for a Property as a pointer to a struct.
propertyName | Name of the Property value to obtain. | |
value | Configured value(s) of the property. | |
num_values |
| |
compCode |
| |
reason |
|
void SCAReleaseCallback | ( | SCAREF | serviceToken, | |
int * | compCode, | |||
int * | reason | |||
) |
Tell the SCA runtime it has completed callback processing and the EndPointrReference can be released.
serviceToken | Token returned by prior SCAGetCallback() call. | |
compCode |
| |
reason | SCA_SERVICE_UNAVAILABLE if the serviceToken is not valid. |
void SCASelf | ( | wchar_t * | serviceName, | |
SCAREF * | serviceToken, | |||
int * | compCode, | |||
int * | reason | |||
) |
Set up to call other operations of a service provided by a component.
serviceName | Name of the Service to access. If a component only provides one service, this string can be empty. | |
serviceToken | Token to be used in subsequent calls. | |
compCode |
| |
reason |
|
void SCASetFaultMessage | ( | wchar_t * | serviceName, | |
wchar_t * | operationName, | |||
wchar_t * | faultName, | |||
int | bufferLen, | |||
void * | buffer, | |||
int * | compCode, | |||
int * | reason | |||
) |
Return a business fault in response to a request.
serviceName | Name of the Service of the component for which the fault is being returned. | |
operationName | Name of the operation of the Service for which the fault is being returned. | |
faultName | Name of the business fault | |
bufferLen | Length of the fault message buffer. | |
buffer | Fault message. | |
compCode |
| |
reason |
|