* OF THIS SOFTWARE.
*
* $Log: proto.h,v $
- * Revision 1.7 1995-05-16 08:50:37 quinn
+ * Revision 1.24 1995-08-29 11:17:43 quinn
+ * *** empty log message ***
+ *
+ * Revision 1.23 1995/08/21 09:10:36 quinn
+ * Smallish fixes to suppport new formats.
+ *
+ * Revision 1.22 1995/08/17 12:45:14 quinn
+ * Fixed minor problems with GRS-1. Added support in c&s.
+ *
+ * Revision 1.21 1995/08/15 12:00:11 quinn
+ * Updated External
+ *
+ * Revision 1.20 1995/08/10 08:54:35 quinn
+ * Added Explain.
+ *
+ * Revision 1.19 1995/06/19 12:38:28 quinn
+ * Reorganized include-files. Added small features.
+ *
+ * Revision 1.18 1995/06/16 13:16:05 quinn
+ * Fixed Defaultdiagformat.
+ *
+ * Revision 1.17 1995/06/15 15:42:05 quinn
+ * Fixed some v3 bugs
+ *
+ * Revision 1.16 1995/06/15 07:45:06 quinn
+ * Moving to v3.
+ *
+ * Revision 1.15 1995/06/14 15:26:43 quinn
+ * *** empty log message ***
+ *
+ * Revision 1.14 1995/06/07 14:42:34 quinn
+ * Fixed CLOSE
+ *
+ * Revision 1.13 1995/06/07 14:36:47 quinn
+ * Added CLOSE
+ *
+ * Revision 1.12 1995/06/05 10:53:13 quinn
+ * Smallish.
+ *
+ * Revision 1.11 1995/06/02 09:49:47 quinn
+ * Add access control
+ *
+ * Revision 1.10 1995/05/29 08:11:34 quinn
+ * Moved oid from odr/asn to util.
+ *
+ * Revision 1.9 1995/05/22 11:31:25 quinn
+ * Added PDUs
+ *
+ * Revision 1.8 1995/05/17 08:41:35 quinn
+ * Added delete to proto & other little things.
+ * Relaying auth info to backend.
+ *
+ * Revision 1.7 1995/05/16 08:50:37 quinn
* License, documentation, and memory fixes
*
* Revision 1.6 1995/05/15 11:55:55 quinn
#define PROTO_H
#include <odr.h>
+#include <oid.h>
#include <odr_use.h>
+#include <yaz-version.h>
+
+/*
+ * Because we didn't have time to put all of the extra v3 elements in here
+ * before the first applications were written, we have to place them
+ * in #ifdefs in places where they would break existing code. If you are
+ * developing new stuff, we urge you to leave them in, even if you don't
+ * intend to use any v3 features. When we are comfortable that the old
+ * apps have been updated, we'll remove the #ifdefs.
+ */
+
+#define Z_95
/* ----------------- GLOBAL AUXILIARY DEFS ----------------*/
+struct Z_External;
+typedef struct Z_External Z_External;
+
typedef Odr_oct Z_ReferenceId;
typedef char Z_DatabaseName;
typedef char Z_ResultSetId;
typedef Odr_oct Z_ResultsetId;
-typedef Odr_external Z_UserInformationField;
+
+typedef struct Z_InfoCategory
+{
+ Odr_oid *categoryTypeId; /* OPTIONAL */
+ int *categoryValue;
+} Z_InfoCategory;
+
+typedef struct Z_OtherInformationUnit
+{
+ Z_InfoCategory *category; /* OPTIONAL */
+ enum
+ {
+ Z_OtherInfo_characterInfo,
+ Z_OtherInfo_binaryInfo,
+ Z_OtherInfo_externallyDefinedInfo,
+ Z_OtherInfo_oid
+ } which;
+ union
+ {
+ char *characterInfo;
+ Odr_oct *binaryInfo;
+ Z_External *externallyDefinedInfo;
+ Odr_oid *oid;
+ } information;
+} Z_OtherInformationUnit;
+
+typedef struct Z_OtherInformation
+{
+ int num_elements;
+ Z_OtherInformationUnit **list;
+} Z_OtherInformation;
+
+typedef struct Z_StringOrNumeric
+{
+ enum
+ {
+ Z_StringOrNumeric_string,
+ Z_StringOrNumeric_numeric
+ } which;
+ union
+ {
+ char *string;
+ int *numeric;
+ } u;
+} Z_StringOrNumeric;
+
+typedef struct Z_Unit
+{
+ char *unitSystem; /* OPTIONAL */
+ Z_StringOrNumeric *unitType; /* OPTIONAL */
+ Z_StringOrNumeric *unit; /* OPTIONAL */
+ int *scaleFactor; /* OPTIONAL */
+} Z_Unit;
+
+typedef struct Z_IntUnit
+{
+ int *value;
+ Z_Unit *unitUsed;
+} Z_IntUnit;
+
+typedef Odr_oct Z_SUTRS;
/* ----------------- INIT SERVICE ----------------*/
{
char *open;
Z_IdPass *idPass;
- void *anonymous; /* NULL */
- Odr_external *other;
+ Odr_null *anonymous;
+ Z_External *other;
} u;
} Z_IdAuthentication;
-#define Z_ProtocolVersion_1 0
-#define Z_ProtocolVersion_2 1
-#define Z_ProtocolVersion_3 2
-
-#define Z_Options_search 0
-#define Z_Options_present 1
-#define Z_Options_delSet 2
-#define Z_Options_resourceReport 3
-#define Z_Options_triggerResourceCtrl 4
-#define Z_Options_resourceCtrl 5
-#define Z_Options_accessCtrl 6
-#define Z_Options_scan 7
-#define Z_Options_sort 8
-#define Z_Options_reserved 9
-#define Z_Options_extendedServices 10
-#define Z_Options_level_1Segmentation 11
-#define Z_Options_level_2Segmentation 12
-#define Z_Options_concurrentOperations 13
-#define Z_Options_namedResultSets 14
+#define Z_ProtocolVersion_1 0
+#define Z_ProtocolVersion_2 1
+#define Z_ProtocolVersion_3 2
+
+#define Z_Options_search 0
+#define Z_Options_present 1
+#define Z_Options_delSet 2
+#define Z_Options_resourceReport 3
+#define Z_Options_triggerResourceCtrl 4
+#define Z_Options_resourceCtrl 5
+#define Z_Options_accessCtrl 6
+#define Z_Options_scan 7
+#define Z_Options_sort 8
+#define Z_Options_reserved 9
+#define Z_Options_extendedServices 10
+#define Z_Options_level_1Segmentation 11
+#define Z_Options_level_2Segmentation 12
+#define Z_Options_concurrentOperations 13
+#define Z_Options_namedResultSets 14
typedef struct Z_InitRequest
{
Z_ReferenceId *referenceId; /* OPTIONAL */
- Odr_bitmask *options;
Odr_bitmask *protocolVersion;
+ Odr_bitmask *options;
int *preferredMessageSize;
int *maximumRecordSize;
Z_IdAuthentication* idAuthentication; /* OPTIONAL */
char *implementationId; /* OPTIONAL */
char *implementationName; /* OPTIONAL */
char *implementationVersion; /* OPTIONAL */
- Z_UserInformationField *userInformationField; /* OPTIONAL */
+ Z_External *userInformationField; /* OPTIONAL */
+#ifdef Z_95
+ Z_OtherInformation *otherInfo; /* OPTIONAL */
+#endif
} Z_InitRequest;
typedef struct Z_InitResponse
{
Z_ReferenceId *referenceId; /* OPTIONAL */
- Odr_bitmask *options;
Odr_bitmask *protocolVersion;
+ Odr_bitmask *options;
int *preferredMessageSize;
int *maximumRecordSize;
bool_t *result;
char *implementationId; /* OPTIONAL */
char *implementationName; /* OPTIONAL */
char *implementationVersion; /* OPTIONAL */
- Z_UserInformationField *userInformationField; /* OPTIONAL */
+ Z_External *userInformationField; /* OPTIONAL */
+#ifdef Z_95
+ Z_OtherInformation *otherInfo; /* OPTIONAL */
+#endif
} Z_InitResponse;
typedef struct Z_NSRAuthentication
int z_StrAuthentication(ODR o, char **p, int opt);
-
-/* ------------------ RESOURCE CONTROL ----------------*/
-
-typedef struct Z_TriggerResourceControlRequest
-{
- Z_ReferenceId *referenceId; /* OPTIONAL */
- int *requestedAction;
-#define Z_TriggerResourceCtrl_resourceReport 1
-#define Z_TriggerResourceCtrl_resourceControl 2
-#define Z_TriggerResourceCtrl_cancel 3
- Odr_oid *prefResourceReportFormat; /* OPTIONAL */
- bool_t *resultSetWanted; /* OPTIONAL */
-} Z_TriggerResourceControlRequest;
-
-typedef struct Z_ResourceControlRequest
-{
- Z_ReferenceId *referenceId; /* OPTIONAL */
- bool_t *suspendedFlag; /* OPTIONAL */
- Odr_external *resourceReport; /* OPTIONAL */
- int *partialResultsAvailable; /* OPTIONAL */
-#define Z_ResourceControlRequest_subset 1
-#define Z_ResourceControlRequest_interim 2
-#define Z_ResourceControlRequest_none 3
- bool_t *responseRequired;
- bool_t *triggeredRequestFlag; /* OPTIONAL */
-} Z_ResourceControlRequest;
-
-typedef struct Z_ResourceControlResponse
-{
- Z_ReferenceId *referenceId; /* OPTIONAL */
- bool_t *continueFlag;
- bool_t *resultSetWanted; /* OPTIONAL */
-} Z_ResourceControlResponse;
-
/* ------------------ SEARCH SERVICE ----------------*/
-typedef Odr_oid Z_PreferredRecordSyntax;
-
typedef struct Z_DatabaseSpecificUnit
{
char *databaseName;
/* ---------------------- RPN QUERY --------------------------- */
+typedef struct Z_ComplexAttribute
+{
+ int num_list;
+ Z_StringOrNumeric **list;
+ int num_semanticAction;
+ int **semanticAction; /* OPTIONAL */
+} Z_ComplexAttribute;
+
typedef struct Z_AttributeElement
{
+#ifdef Z_95
+ Odr_oid *attributeSet; /* OPTIONAL - v3 only */
+#endif
int *attributeType;
+#ifdef Z_95
+ enum
+ {
+ Z_AttributeValue_numeric,
+ Z_AttributeValue_complex
+ } which;
+ union
+ {
+ int *numeric;
+ Z_ComplexAttribute *complex;
+ } value;
+#else
int *attributeValue;
+#endif
} Z_AttributeElement;
-#define Z_V3
-#ifdef Z_V3
-
typedef struct Z_Term
{
enum
char *characterString;
Odr_oid *oid;
char *dateTime;
- Odr_external *external;
+ Z_External *external;
/* Z_IntUnit *integerAndUnit; */
- void *null;
+ Odr_null *null;
} u;
} Z_Term;
-#endif
-
typedef struct Z_AttributesPlusTerm
{
int num_attributes;
Z_AttributeElement **attributeList;
-#ifdef Z_V3
Z_Term *term;
-#else
- Odr_oct *term;
-#endif
} Z_AttributesPlusTerm;
+typedef struct Z_ResultSetPlusAttributes
+{
+ char *resultSet;
+ int num_attributes;
+ Z_AttributeElement **attributeList;
+} Z_ResultSetPlusAttributes;
+
typedef struct Z_ProximityOperator
{
bool_t *exclusion; /* OPTIONAL */
int *distance;
bool_t *ordered;
int *relationType;
+#define Z_Prox_lessThan 1
+#define Z_Prox_lessThanOrEqual 2
+#define Z_Prox_equal 3
+#define Z_Prox_greaterThanOrEqual 4
+#define Z_Prox_greaterThan 5
+#define Z_Prox_notEqual 6
enum
{
- Z_ProximityOperator_known,
- Z_ProximityOperator_private
+ Z_ProxCode_known,
+ Z_ProxCode_private
} which;
- union
- {
- int *known;
- int *private;
- } u;
+ int *proximityUnitCode;
+#define Z_ProxUnit_character 1
+#define Z_ProxUnit_word 2
+#define Z_ProxUnit_sentence 3
+#define Z_ProxUnit_paragraph 4
+#define Z_ProxUnit_section 5
+#define Z_ProxUnit_chapter 6
+#define Z_ProxUnit_document 7
+#define Z_ProxUnit_element 8
+#define Z_ProxUnit_subelement 9
+#define Z_ProxUnit_elementType 10
+#define Z_ProxUnit_byte 11 /* v3 only */
} Z_ProximityOperator;
typedef struct Z_Operator
Z_Operator_and,
Z_Operator_or,
Z_Operator_and_not,
- Z_Operator_proximity
+ Z_Operator_prox
} which;
union
{
- void *and; /* these guys are nulls. */
- void *or;
- void *and_not;
- Z_ProximityOperator *proximity;
+ Odr_null *and; /* these guys are nulls. */
+ Odr_null *or;
+ Odr_null *and_not;
+ Z_ProximityOperator *prox;
} u;
} Z_Operator;
typedef struct Z_Operand
{
- int which;
-#define Z_Operand_APT 0
-#define Z_Operand_resultSetId 1
+ enum
+ {
+ Z_Operand_APT,
+ Z_Operand_resultSetId,
+ Z_Operand_resultAttr /* v3 only */
+ } which;
union
{
Z_AttributesPlusTerm *attributesPlusTerm;
Z_ResultSetId *resultSetId;
+ Z_ResultSetPlusAttributes *resultAttr;
} u;
} Z_Operand;
typedef struct Z_RPNStructure
{
- int which;
-#define Z_RPNStructure_simple 0
-#define Z_RPNStructure_complex 1
+ enum
+ {
+ Z_RPNStructure_simple,
+ Z_RPNStructure_complex
+ } which;
union
{
Z_Operand *simple;
typedef struct Z_Query
{
- int which;
-#define Z_Query_type_1 1
-#define Z_Query_type_2 2
+ enum
+ {
+ Z_Query_type_1 = 1,
+ Z_Query_type_2,
+ Z_Query_type_101
+ }
+ which;
union
{
Z_RPNQuery *type_1;
Odr_oct *type_2;
+ Z_RPNQuery *type_101;
} u;
} Z_Query;
char **databaseNames;
Z_ElementSetNames *smallSetElementSetNames; /* OPTIONAL */
Z_ElementSetNames *mediumSetElementSetNames; /* OPTIONAL */
- Z_PreferredRecordSyntax *preferredRecordSyntax; /* OPTIONAL */
+ Odr_oid *preferredRecordSyntax; /* OPTIONAL */
Z_Query *query;
+#ifdef Z_95
+ Z_OtherInformation *additionalSearchInfo; /* OPTIONAL */
+ Z_OtherInformation *otherInfo; /* OPTIONAL */
+#endif
} Z_SearchRequest;
/* ------------------------ RECORD -------------------------- */
-typedef Odr_external Z_DatabaseRecord;
+typedef Z_External Z_DatabaseRecord;
+
+#ifdef Z_95
+
+typedef struct Z_DefaultDiagFormat
+{
+ Odr_oid *diagnosticSetId; /* This is opt'l to interwork with bad targets */
+ int *condition;
+ /* until the whole character set issue becomes more definite,
+ * you can probably ignore this on input. */
+ enum
+ {
+ Z_DiagForm_v2AddInfo,
+ Z_DiagForm_v3AddInfo
+ } which;
+ char *addinfo;
+} Z_DefaultDiagFormat;
typedef struct Z_DiagRec
{
- Odr_oid *diagnosticSetId;
+ enum
+ {
+ Z_DiagRec_defaultFormat,
+ Z_DiagRec_externallyDefined
+ } which;
+ union
+ {
+ Z_DefaultDiagFormat *defaultFormat;
+ Z_External *externallyDefined;
+ } u;
+} Z_DiagRec;
+
+#else
+
+typedef struct Z_DiagRec
+{
+ Odr_oid *diagnosticSetId; /* This is opt'l to interwork with bad targets */
int *condition;
char *addinfo;
} Z_DiagRec;
+#endif
+
+typedef struct Z_DiagRecs
+{
+ int num_diagRecs;
+ Z_DiagRec **diagRecs;
+} Z_DiagRecs;
+
typedef struct Z_NamePlusRecord
{
char *databaseName; /* OPTIONAL */
- int which;
-#define Z_NamePlusRecord_databaseRecord 0
-#define Z_NamePlusRecord_surrogateDiagnostic 1
+ enum
+ {
+ Z_NamePlusRecord_databaseRecord,
+ Z_NamePlusRecord_surrogateDiagnostic
+ }
+ which;
union
{
Z_DatabaseRecord *databaseRecord;
typedef struct Z_Records
{
- int which;
-#define Z_Records_DBOSD 0
-#define Z_Records_NSD 1
+ enum
+ {
+ Z_Records_DBOSD,
+ Z_Records_NSD,
+ Z_Records_multipleNSD
+ } which;
union
{
Z_NamePlusRecordList *databaseOrSurDiagnostics;
Z_DiagRec *nonSurrogateDiagnostic;
+ Z_DiagRecs *multipleNonSurDiagnostics;
} u;
} Z_Records;
+/* ------------------------ SEARCHRESPONSE ------------------ */
+
+typedef struct Z_SearchResponse
+{
+ Z_ReferenceId *referenceId; /* OPTIONAL */
+ int *resultCount;
+ int *numberOfRecordsReturned;
+ int *nextResultSetPosition;
+ bool_t *searchStatus;
+ int *resultSetStatus; /* OPTIONAL */
+#define Z_RES_SUBSET 1
+#define Z_RES_INTERIM 2
+#define Z_RES_NONE 3
+ int *presentStatus; /* OPTIONAL */
+#define Z_PRES_SUCCESS 0
+#define Z_PRES_PARTIAL_1 1
+#define Z_PRES_PARTIAL_2 2
+#define Z_PRES_PARTIAL_3 3
+#define Z_PRES_PARTIAL_4 4
+#define Z_PRES_FAILURE 5
+ Z_Records *records; /* OPTIONAL */
+#ifdef Z_95
+ Z_OtherInformation *additionalSearchInfo;
+ Z_OtherInformation *otherInfo;
+#endif
+} Z_SearchResponse;
+
+/* ------------------------- PRESENT SERVICE -----------------*/
+
+typedef struct Z_ElementSpec
+{
+ enum
+ {
+ Z_ElementSpec_elementSetName,
+ Z_ElementSpec_externalSpec
+ } which;
+ union
+ {
+ char *elementSetName;
+ Z_External *externalSpec;
+ } u;
+} Z_ElementSpec;
+
+typedef struct Z_Specification
+{
+ Odr_oid *schema; /* OPTIONAL */
+ Z_ElementSpec *elementSpec; /* OPTIONAL */
+} Z_Specification;
+
+typedef struct Z_DbSpecific
+{
+ char *databaseName;
+ Z_Specification *spec;
+} Z_DbSpecific;
+
+typedef struct Z_CompSpec
+{
+ bool_t *selectAlternativeSyntax;
+ Z_Specification *generic; /* OPTIONAL */
+ int num_dbSpecific;
+ Z_DbSpecific **dbSpecific; /* OPTIONAL */
+ int num_recordSyntax;
+ Odr_oid **recordSyntax; /* OPTIONAL */
+} Z_CompSpec;
+
+typedef struct Z_RecordComposition
+{
+ enum
+ {
+ Z_RecordComp_simple,
+ Z_RecordComp_complex
+ } which;
+ union
+ {
+ Z_ElementSetNames *simple;
+ Z_CompSpec *complex;
+ } u;
+} Z_RecordComposition;
+
+typedef struct Z_Range
+{
+ int *startingPosition;
+ int *numberOfRecords;
+} Z_Range;
+
+typedef struct Z_PresentRequest
+{
+ Z_ReferenceId *referenceId; /* OPTIONAL */
+ Z_ResultSetId *resultSetId;
+ int *resultSetStartPoint;
+ int *numberOfRecordsRequested;
+#ifdef Z_95
+ int num_ranges;
+ Z_Range **additionalRanges; /* OPTIONAL */
+ Z_RecordComposition *recordComposition; /* OPTIONAL */
+#else
+ Z_ElementSetNames *elementSetNames; /* OPTIONAL */
+#endif
+ Odr_oid *preferredRecordSyntax; /* OPTIONAL */
+#ifdef Z_95
+ int *maxSegmentCount; /* OPTIONAL */
+ int *maxRecordSize; /* OPTIONAL */
+ int *maxSegmentSize; /* OPTIONAL */
+ Z_OtherInformation *otherInfo; /* OPTIONAL */
+#endif
+} Z_PresentRequest;
+
+typedef struct Z_PresentResponse
+{
+ Z_ReferenceId *referenceId; /* OPTIONAL */
+ int *numberOfRecordsReturned;
+ int *nextResultSetPosition;
+ int *presentStatus;
+ Z_Records *records;
+#ifdef Z_95
+ Z_OtherInformation *otherInfo; /* OPTIONAL */
+#endif
+} Z_PresentResponse;
+
+/* ------------------ RESOURCE CONTROL ----------------*/
+
+typedef struct Z_TriggerResourceControlRequest
+{
+ Z_ReferenceId *referenceId; /* OPTIONAL */
+ int *requestedAction;
+#define Z_TriggerResourceCtrl_resourceReport 1
+#define Z_TriggerResourceCtrl_resourceControl 2
+#define Z_TriggerResourceCtrl_cancel 3
+ Odr_oid *prefResourceReportFormat; /* OPTIONAL */
+ bool_t *resultSetWanted; /* OPTIONAL */
+#ifdef Z_95
+ Z_OtherInformation *otherInfo;
+#endif
+} Z_TriggerResourceControlRequest;
+
+typedef struct Z_ResourceControlRequest
+{
+ Z_ReferenceId *referenceId; /* OPTIONAL */
+ bool_t *suspendedFlag; /* OPTIONAL */
+ Z_External *resourceReport; /* OPTIONAL */
+ int *partialResultsAvailable; /* OPTIONAL */
+#define Z_ResourceControlRequest_subset 1
+#define Z_ResourceControlRequest_interim 2
+#define Z_ResourceControlRequest_none 3
+ bool_t *responseRequired;
+ bool_t *triggeredRequestFlag; /* OPTIONAL */
+#ifdef Z_95
+ Z_OtherInformation *otherInfo;
+#endif
+} Z_ResourceControlRequest;
+
+typedef struct Z_ResourceControlResponse
+{
+ Z_ReferenceId *referenceId; /* OPTIONAL */
+ bool_t *continueFlag;
+ bool_t *resultSetWanted; /* OPTIONAL */
+#ifdef Z_95
+ Z_OtherInformation *otherInfo;
+#endif
+} Z_ResourceControlResponse;
+
+
+/* ------------------ ACCESS CTRL SERVICE ----------------*/
+
+typedef struct Z_AccessControlRequest
+{
+ Z_ReferenceId *referenceId; /* OPTIONAL */
+ enum
+ {
+ Z_AccessRequest_simpleForm,
+ Z_AccessRequest_externallyDefined
+ } which;
+ union
+ {
+ Odr_oct *simpleForm;
+ Z_External *externallyDefined;
+ } u;
+#ifdef Z_95
+ Z_OtherInformation *otherInfo; /* OPTIONAL */
+#endif
+} Z_AccessControlRequest;
+
+typedef struct Z_AccessControlResponse
+{
+ Z_ReferenceId *referenceId; /* OPTIONAL */
+ enum
+ {
+ Z_AccessResponse_simpleForm,
+ Z_AccessResponse_externallyDefined
+ } which;
+ union
+ {
+ Odr_oct *simpleForm;
+ Z_External *externallyDefined;
+ } u;
+ Z_DiagRec *diagnostic; /* OPTIONAL */
+#ifdef Z_95
+ Z_OtherInformation *otherInfo; /* OPTIONAL */
+#endif
+} Z_AccessControlResponse;
+
/* ------------------------ SCAN SERVICE -------------------- */
typedef struct Z_AttributeList
Z_Entry **entries;
} Z_Entries;
-typedef struct Z_DiagRecs
-{
- int num_diagRecs;
- Z_DiagRec **diagRecs;
-} Z_DiagRecs;
-
typedef struct Z_ListEntries
{
enum
int num_databaseNames;
char **databaseNames;
Odr_oid *attributeSet; /* OPTIONAL */
- Odr_any *eatme1;
Z_AttributesPlusTerm *termListAndStartPoint;
int *stepSize; /* OPTIONAL */
int *numberOfTermsRequested;
int *preferredPositionInResponse; /* OPTIONAL */
+#ifdef Z_95
+ Z_OtherInformation *otherInfo;
+#endif
} Z_ScanRequest;
typedef struct Z_ScanResponse
int *positionOfTerm; /* OPTIONAL */
Z_ListEntries *entries; /* OPTIONAL */
Odr_oid *attributeSet; /* OPTIONAL */
+#ifdef Z_95
+ Z_OtherInformation *otherInfo;
+#endif
} Z_ScanResponse;
-/* ------------------------ SEARCHRESPONSE ------------------ */
-
-typedef struct Z_SearchResponse
-{
- Z_ReferenceId *referenceId; /* OPTIONAL */
- int *resultCount;
- int *numberOfRecordsReturned;
- int *nextResultSetPosition;
- bool_t *searchStatus;
- int *resultSetStatus; /* OPTIONAL */
-#define Z_RES_SUBSET 1
-#define Z_RES_INTERIM 2
-#define Z_RES_NONE 3
- int *presentStatus; /* OPTIONAL */
-#define Z_PRES_SUCCESS 0
-#define Z_PRES_PARTIAL_1 1
-#define Z_PRES_PARTIAL_2 2
-#define Z_PRES_PARTIAL_3 3
-#define Z_PRES_PARTIAL_4 4
-#define Z_PRES_FAILURE 5
- Z_Records *records; /* OPTIONAL */
-} Z_SearchResponse;
-
-/* ------------------------- PRESENT SERVICE -----------------*/
-
-typedef struct Z_PresentRequest
-{
- Z_ReferenceId *referenceId; /* OPTIONAL */
- Z_ResultSetId *resultSetId;
- int *resultSetStartPoint;
- int *numberOfRecordsRequested;
- Z_ElementSetNames *elementSetNames; /* OPTIONAL */
- Z_PreferredRecordSyntax *preferredRecordSyntax; /* OPTIONAL */
-} Z_PresentRequest;
-
-typedef struct Z_PresentResponse
-{
- Z_ReferenceId *referenceId; /* OPTIONAL */
- int *numberOfRecordsReturned;
- int *nextResultSetPosition;
- int *presentStatus;
- Z_Records *records;
-} Z_PresentResponse;
/* ------------------------ DELETE -------------------------- */
+#define Z_DeleteStatus_success 0
+#define Z_DeleteStatus_resultSetDidNotExist 1
+#define Z_DeleteStatus_previouslyDeletedByTarget 2
+#define Z_DeleteStatus_systemProblemAtTarget 3
+#define Z_DeleteStatus_accessNotAllowed 4
+#define Z_DeleteStatus_resourceControlAtOrigin 5
+#define Z_DeleteStatus_resourceControlAtTarget 6
+#define Z_DeleteStatus_bulkDeleteNotSupported 7
+#define Z_DeleteStatus_notAllRsltSetsDeletedOnBulkDlte 8
+#define Z_DeleteStatus_notAllRequestedResultSetsDeleted 9
+#define Z_DeleteStatus_resultSetInUse 10
+
typedef struct Z_ListStatus
{
Z_ResultSetId *id;
#define Z_DeleteRequest_list 0
#define Z_DeleteRequest_all 1
int num_ids;
- Z_ResultSetId *resultSetList; /* OPTIONAL */
+ Z_ResultSetId **resultSetList; /* OPTIONAL */
+#ifdef Z_95
+ Z_OtherInformation *otherInfo;
+#endif
} Z_DeleteResultSetRequest;
-typedef enum Z_DeleteSetStatus
-{
- Z_Delete_success = 0,
- Z_Delete_resultSetDidNotExist,
- Z_Delete_previouslyDeletedByTarget,
- Z_Delete_systemProblemAtTarget,
- Z_Delete_accessNotAllowed,
- Z_Delete_resourceControlAtOrigin,
- Z_Delete_resourceControlAtTarget,
- Z_Delete_bulkDeleteNotSupported,
- Z_Delete_notAllRsltSetsDeletedOnBulkDlte,
- Z_Delete_notAllRequestedResultSetsDeleted,
- Z_Delete_resultSetInUse
-} Z_DeleteSetStatus;
-
typedef struct Z_DeleteResultSetResponse
{
Z_ReferenceId *referenceId; /* OPTIONAL */
int num_statuses;
Z_ListStatus *deleteListStatuses; /* OPTIONAL */
int *numberNotDeleted; /* OPTIONAL */
- int num_bulkstatuses;
+ int num_bulkStatuses;
Z_ListStatus *bulkStatuses; /* OPTIONAL */
char *deleteMessage; /* OPTIONAL */
+#ifdef Z_95
+ Z_OtherInformation *otherInfo;
+#endif
} Z_DeleteResultSetResponse;
+/* ------------------------ CLOSE SERVICE ------------------- */
+
+typedef struct Z_Close
+{
+ Z_ReferenceId *referenceId; /* OPTIONAL */
+ int *closeReason;
+#define Z_Close_finished 0
+#define Z_Close_shutdown 1
+#define Z_Close_systemProblem 2
+#define Z_Close_costLimit 3
+#define Z_Close_resources 4
+#define Z_Close_securityViolation 5
+#define Z_Close_protocolError 6
+#define Z_Close_lackOfActivity 7
+#define Z_Close_peerAbort 8
+#define Z_Close_unspecified 9
+ char *diagnosticInformation; /* OPTIONAL */
+ Odr_oid *resourceReportFormat; /* OPTIONAL */
+ Z_External *resourceReport; /* OPTIONAL */
+#ifdef Z_95
+ Z_OtherInformation *otherInfo; /* OPTIONAL */
+#endif
+} Z_Close;
+
+/* ------------------------ SEGMENTATION -------------------- */
+
+typedef struct Z_Segment
+{
+ Z_ReferenceId *referenceId; /* OPTIONAL */
+ int *numberOfRecordsReturned;
+ int num_segmentRecords;
+ Z_NamePlusRecord **segmentRecords;
+ Z_OtherInformation *otherInfo; /* OPTIONAL */
+} Z_Segment;
+
+/* ----------------------- Extended Services ---------------- */
+
+typedef struct Z_Permissions
+{
+ char *userId;
+ int num_allowableFunctions;
+ int **allowableFunctions;
+#define Z_Permissions_delete 1
+#define Z_Permissions_modifyContents 2
+#define Z_Permissions_modifyPermissions 3
+#define Z_Permissions_present 4
+#define Z_Permissions_invoke 5
+} Z_Permissions;
+
+typedef struct Z_ExtendedServicesRequest
+{
+ Z_ReferenceId *referenceId; /* OPTIONAL */
+ int *function;
+#define Z_ExtendedServicesRequest_create 1
+#define Z_ExtendedServicesRequest_delete 2
+#define Z_ExtendedServicesRequest_modify 3
+ Odr_oid *packageType;
+ char *packageName; /* OPTIONAL */
+ char *userId; /* OPTIONAL */
+ Z_IntUnit *retentionTime; /* OPTIONAL */
+ Z_Permissions *permissions; /* OPTIONAL */
+ char *description; /* OPTIONAL */
+ Z_External *taskSpecificParameters; /* OPTIONAL */
+ int *waitAction;
+#define Z_ExtendedServicesRequest_wait 1
+#define Z_ExtendedServicesRequest_waitIfPossible 2
+#define Z_ExtendedServicesRequest_dontWait 3
+#define Z_ExtendedServicesRequest_dontReturnPackage 4
+ char *elements; /* OPTIONAL */
+ Z_OtherInformation *otherInfo; /* OPTIONAL */
+} Z_ExtendedServicesRequest;
+
+typedef struct Z_ExtendedServicesResponse
+{
+ Z_ReferenceId *referenceId; /* OPTIONAL */
+ int *operationStatus;
+#define Z_ExtendedServicesResponse_done 1
+#define Z_ExtendedServicesResponse_accepted 2
+#define Z_ExtendedServicesResponse_failure 3
+ int num_diagnostics;
+ Z_DiagRec **diagnostics; /* OPTIONAL */
+ Z_External *taskPackage; /* OPTIONAL */
+ Z_OtherInformation *otherInfo; /* OPTIONAL */
+} Z_ExtendedServicesResponse;
+
/* ------------------------ APDU ---------------------------- */
typedef struct Z_APDU
{
- enum
+ enum Z_APDU_which
{
Z_APDU_initRequest,
Z_APDU_initResponse,
Z_APDU_searchResponse,
Z_APDU_presentRequest,
Z_APDU_presentResponse,
+ Z_APDU_deleteResultSetRequest,
+ Z_APDU_deleteResultSetResponse,
Z_APDU_resourceControlRequest,
Z_APDU_resourceControlResponse,
Z_APDU_triggerResourceControlRequest,
Z_APDU_scanRequest,
- Z_APDU_scanResponse
+ Z_APDU_scanResponse,
+ Z_APDU_segmentRequest,
+ Z_APDU_extendedServicesRequest,
+ Z_APDU_extendedServicesResponse,
+ Z_APDU_close
} which;
union
{
Z_SearchResponse *searchResponse;
Z_PresentRequest *presentRequest;
Z_PresentResponse *presentResponse;
+ Z_DeleteResultSetRequest *deleteResultSetRequest;
+ Z_DeleteResultSetResponse *deleteResultSetResponse;
Z_ResourceControlRequest *resourceControlRequest;
Z_ResourceControlResponse *resourceControlResponse;
Z_TriggerResourceControlRequest *triggerResourceControlRequest;
Z_ScanRequest *scanRequest;
Z_ScanResponse *scanResponse;
+ Z_Segment *segmentRequest;
+ Z_ExtendedServicesRequest *extendedServicesRequest;
+ Z_ExtendedServicesResponse *extendedServicesResponse;
+ Z_Close *close;
} u;
} Z_APDU;
int z_APDU(ODR o, Z_APDU **p, int opt);
+int z_SUTRS(ODR o, Odr_oct **p, int opt);
+
+Z_InitRequest *zget_InitRequest(ODR o);
+Z_InitResponse *zget_InitResponse(ODR o);
+Z_SearchRequest *zget_SearchRequest(ODR o);
+Z_SearchResponse *zget_SearchResponse(ODR o);
+Z_PresentRequest *zget_PresentRequest(ODR o);
+Z_PresentResponse *zget_PresentResponse(ODR o);
+Z_DeleteResultSetRequest *zget_DeleteResultSetRequest(ODR o);
+Z_DeleteResultSetResponse *zget_DeleteResultSetResponse(ODR o);
+Z_ScanRequest *zget_ScanRequest(ODR o);
+Z_ScanResponse *zget_ScanResponse(ODR o);
+Z_TriggerResourceControlRequest *zget_TriggerResourceControlRequest(ODR o);
+Z_ResourceControlRequest *zget_ResourceControlRequest(ODR o);
+Z_ResourceControlResponse *zget_ResourceControlResponse(ODR o);
+Z_Close *zget_Close(ODR o);
+int z_InternationalString(ODR o, char **p, int opt);
+int z_OtherInformation(ODR o, Z_OtherInformation **p, int opt);
+int z_ElementSetName(ODR o, char **p, int opt);
+int z_IntUnit(ODR o, Z_IntUnit **p, int opt);
+int z_Unit(ODR o, Z_Unit **p, int opt);
+int z_DatabaseName(ODR o, Z_DatabaseName **p, int opt);
+int z_StringOrNumeric(ODR o, Z_StringOrNumeric **p, int opt);
+int z_OtherInformationUnit(ODR o, Z_OtherInformationUnit **p, int opt);
+int z_Term(ODR o, Z_Term **p, int opt);
+int z_Specification(ODR o, Z_Specification **p, int opt);
+int z_Permissions(ODR o, Z_Permissions **p, int opt);
+int z_DiagRec(ODR o, Z_DiagRec **p, int opt);
+int z_AttributeList(ODR o, Z_AttributeList **p, int opt);
+int z_DefaultDiagFormat(ODR o, Z_DefaultDiagFormat **p, int opt);
+Z_APDU *zget_APDU(ODR o, enum Z_APDU_which which);
+
+#include <prt-rsc.h>
+#include <prt-acc.h>
+#include <prt-exp.h>
+#include <prt-grs.h>
+#include <prt-exd.h>
+#include <prt-dia.h>
+
+#include <prt-ext.h>
#endif
projects / yaz-moved-to-github.git / blobdiff