NonStop SOAP 4.1 User's Manual

5 NonStop SOAP 4 Service APIs
This chapter describes the NonStop SOAP 4 application programming interfaces (APIs) you can
use to develop a DLL-based Web service deployed in NonStop SOAP 4.
This chapter includes the following topics:
• “Basic NonStop SOAP 4 Service APIs” (page 85)
• “Developing NonStop SOAP 4 Services using Service APIs” (page 95)
Basic NonStop SOAP 4 Service APIs
NonStop SOAP 4 service APIs provide a stack of function calls to develop Web services that you
can deploy in NonStop SOAP 4.
The following service APIs are described in this section:
• “APIs to Implement the Service Interface with NonStop SOAP 4” (page 85)
• “APIs to Implement the Service Skeleton Structure Interface” (page 87)
• “APIs to Extract the Input Parameters and Return the Response” (page 89)
• “APIs for Logging” (page 95)
APIs to Implement the Service Interface with NonStop SOAP 4
Services developed using NonStop SOAP 4 service APIs must implement the following functions:
• “The axis2_get_instance()Function” (page 85)
• “The axis2_remove_instance()Function” (page 86)
The axis2_get_instance()Function
NonStop SOAP 4 calls the axis2_get_instance() function when it loads the service for the
first time. It does not call this function in subsequent invocations of the service. The
axis2_get_instance()function creates an instance of the service skeleton structure.
The following tasks are performed by the axis2_get_instance()function implemented in your
service:
1. “Creating the service skeleton structure” (page 86)
2. “Setting the service skeleton operations structure” (page 86)
3. “Returning the service skeleton structure to the service” (page 86)
Synopsis:
AXIS2_EXPORT int axis2_get_instance(
struct axis2_svc_skeleton **inst,
const axutil_env_t * env)
Parameters:
inst
is an output parameter that points to the service skeleton structure.
env
is an input parameter and is a pointer to the environment structure. It cannot have a NULL
value.
Return Values:
• AXIS2_SUCCESS on success.
• AXIS2_FAILURE on failure.
Basic NonStop SOAP 4 Service APIs 85