Events received from the Proxy Interface (ISLE_SrvProxyInform)

4.5.4.4.3.2Compound Actions

^PIF.PeerAbort(diagnostic)

^AIF.PeerAbort(diagnostic)

/CLEANUP

/clear remote returns

/clear local returns

/set data queued = FALSE

IF data queued THEN

/reject(transfer suspended)

ELSE

IF not data transmitted THEN

/set data queued = TRUE

/suspend data transfer

END IF

END IF

IF data queued THEN

/set data queued = FALSE

^AIF.ResumeDataTransfer

END IF

4.5.4.4.4Forward Link State Table—User Side

1. 
   In the state UNBIND-PENDING, returns can still be received from the peer.
   
2. 
   In the state UNBIND-PENDING, no further invocations should be sent by the peer. However, the peer may not yet have seen the UNBIND invocation. Therefore all invocations are passed to the application. The application should no longer respond.
   

1. 
   

   Specification of Common Interfaces

   (Normative)
   

   1. 
      Introduction
      

The interface specifications are structured according to the components that must provide the implementation:

1. 
   Interfaces implemented by the component ‘SLE Utilities’ are defined in A.1.15.1.1.1.1.1.11.
   
2. 
   Interfaces implemented by the component ‘SLE Operations’ are defined in A.1.22.1.1.1.1.1.11.
   
3. 
   Interfaces implemented by the component ‘API Proxy’ are defined in A.1.29.1.1.1.1.1.11.
   
4. 
   Interfaces implemented by the component ‘API Service Element’ are defined in A.1.33.1.1.1.1.1.11.
   
5. 
   Interfaces that must be provided by the SLE Application are defined in A.1.40.1.1.1.1.1.11.
   

Subsection A.1.13.1.1.1.1.1.11 defines types used throughout the remaining subsections.

The conventions used for the specification are explained in 2.

The specifications of this annex are complemented by the definition of the ‘Simple Component Model’ in annex A.1.48.1.1.1.1.2.

1. 
   Conventions
   
1. 
   Overview
   

3. 
   Interfaces
   

#define interface struct

in the file SLE_SCM.H described in annex A.1.48.1.1.1.1.2. All interfaces are directly or indirectly derived from the interface IUnknown, which is also defined in SLE_SCM.H.

4. 
   Naming Conventions
   

1. 
   All types, i.e.:
   

1. 
   Interfaces (e.g., ISLE_Bind);
   
2. 
   enumeration types (e.g., SLE_ParameterName);
   
3. 
   other types declared by typedef (e.g., SLE_InvokeId);
   

2. 
   Method names (e.g., InitiateOpInvoke()).
   

1. 
   variables;
   
2. 
   arguments of methods;
   
3. 
   enumeration labels.
   

All interfaces start with a capital ‘I’, such that interface names are prefixed with ‘ISLE’.

NOTE – The interface IMalloc defined in A.1.18 is the only exception to this rule because of the considerations presented in A.1.7.

Because enumeration labels are defined at global scope, the prefix is extended to include an abbreviation for the enumeration type. For instance, all labels of the enumeration type SLE_ParameterName are prefixed by ‘slePN’.

An underscore character is used to separate the prefix from the name. Within the name itself upper and lower case is used to improve readability.

5. 
   Access to Object Attributes
   

When the attribute type is not a basic type (e.g., a character string) the following conventions are applied:

1. 
   If it can be assumed that the implementation stores the attribute in the format in which it is delivered, the return value is defined to be const. In these cases, the client must copy the value if it wants to modify it.
   
2. 
   If the object implementation might have to derive the value a pointer to a not constant object is returned. In these cases the client must delete the returned value.
   
3. 
   In order to optimize performance, an additional retrieval method, prefixed by ‘Remove_’ is defined for attributes that might become large (e.g., the space link data). These methods return a pointer to the internal representation and remove that pointer from the object itself. The client calling that method must make sure the memory is released when the data are no longer needed.
   
4. 
   For setting of attributes a pointer or reference to a const object is generally used. For potentially larger arguments, an additional method (prefixed by ‘Put’) is defined which passes a pointer to a not constant object. In these cases the implementation is expected to delete the data passed with the argument, when it no longer needs it.
   

6. 
   Conditional and Optional Attributes
   

1. 
   conditional, i.e., their value is only defined when another attribute has a certain value;
   
2. 
   optional, i.e., the value may or may not be defined.
   

For access to optional attributes, different approaches are used, depending on the type of the attribute:

1. 
   For enumeration types, an additional enumeration value ‘undefined’ is added to the type declaration. This value is returned if the attribute is currently undefined.
   
2. 
   Object types or composite C++ types, such as arrays or structures are returned via a pointer to a constant object, instead of using a reference to a constant object. If an optional attribute is undefined, the access method returns a NULL pointer.
   
3. 
   For simple types the following cases are distinguished:
   

1. 
   if the valid range of attribute values does not include the complete range covered by the type, a special value is selected to indicate that the attribute is not defined;
   
2. 
   in other cases, a special method is provided to check whether the attribute is defined or not.
   

7. 
   Memory Management
   

Therefore this Recommended Practice defines a specific memory management interface IMalloc, which must be used by all API components and by the application when creating or deleting data structures to which pointers are passed across component boundaries. The interface IMalloc is implemented by the component SLE Utilities. A pointer to the interface can be obtained using the method CreateMemoryManager() of the Utility Factory.

NOTES

1. 
   Memory management for objects created by API components is controlled by the reference counting scheme for interfaces described in annex A.1.48.1.1.1.1.2. This scheme implies that the memory for such objects is always allocated and released by the same component. Therefore the means by which memory is allocated and released for such objects is considered a local implementation issue and not prescribed by this Recommended Practice. The same applies to interfaces, which are implemented by objects within the application software.
   
2. 
   Data structures, which might be created by one component and deleted by another component, are generally strings, arrays or structures passed by Put_xxx() or Remove_xxx() methods.
   
3. 
   For data that are never passed across component boundaries and for data that are always passed by value, memory management is considered a local implementation issue and not prescribed by this Recommended Practice.
   
4. 
   As specified in A.1.5, this Recommended Practice applies the convention that data, which are passed across component boundaries using a reference to a constant data structure or a pointer to a constant data structure, must not be deleted by the calling software. Therefore use of the memory manager interface IMalloc is not mandated if a data structure is only passed across component boundaries in these ways.
   
5. 
   The specification of the interface IMalloc defines a subset of the COM interface IMalloc, in order to enable use of the SLE API in a COM environment. Further details concerning the use of this interface and the implementation of the interface in other environments can be found in A.1.18 and annex A.1.48.1.1.1.1.2.
   

8. 
   Interface Identifiers
   

The name of the macro is constructed as IID__DEF Guidelines for use of this macro can be found in annex A.1.48.1.1.1.1.2.

9. 
   Type Definitions
   

1. 
   SLE_Types.h for types derived from the CCSDS Recommended Standards for SLE transfer services;
   
2. 
   SLE_APITypes.h for types specified by the API.
   

10. 
    Result Codes
    

11. 
    Function Overloading
    

12. 
    Object Creation Methods
    

1. 
   the GUID of the interface is passed as an input argument (and checked by the implementation);
   
2. 
   a pointer to the interface of the object is passed as an output argument of the type void**;
   
3. 
   the method returns a result code.
   

13. 
    Files
    

1. 
   Type Definitions
   
1. 
   SLE Types
   
   1. 
      General
      

/* The following basic types have been derived from the ASN.1 modules in the CCSDS Recommended Standards for SLE transfer services. The source ASN.1 type is indicated in brackets. For all enumeration types a special value ‘invalid’ is defined, which is returned if the associated value in the operation object has not yet been set, or is not applicable in case of a choice.

The type definitions in this specification cover all those types that are common for all service types or for a subset of service types. These types are defined in the ASN.1 modules:

1. 
   CCSDS-SLE-TRANSFER-SERVICE-COMMON-TYPES;
   
2. 
   CCSDS-SLE-TRANSFER-SERVICE-BIND-TYPES; and
   
3. 
   CCSDS-SLE-TRANSFER-COMMON-PDUS.
   

2. 
   /* Auxiliary Types */
   

#ifndef _SIZE_T

#define _SIZE_T

typedef unsigned int size_t;

#endif

/* On POSIX systems, size_t is defined by standard header files; redefinition must be prevented by conditional compilation. */

typedef unsigned char SLE_Octet;

/* In order to distinguish between character strings and sequences of octets (bytes) frequently used by SLE Service specifications, the API defines a special type for an octet. The type char* always refers to a zero terminated string of characters. */

/* Yes/No Value */

typedef enum SLE_YesNo

{

sleYN_No = 0,

sleYN_invalid = -1

} SLE_YesNo;

/* The type describes a Boolean value, which might not be available at certain times. */

3. 
   /* Types derived from CCSDS-SLE-TRANSFER-SERVICE-COMMON-TYPES */
   

typedef enum SLE_DeliveryMode

{

sleDM_rtnTimelyOnline = 0,

sleDM_rtnOffline = 2,

sleDM_fwdOnline = 3,

sleDM_fwdOffline = 4,

sleDM_invalid = -1

} SLE_DeliveryMode;

typedef enum SLE_Diagnostics

{

sleD_duplicateInvokeId = 100,

sleD_invalid = -1

} SLE_Diagnostics;

/* Forward Data Unit Status [ForwardDuStatus] */

typedef enum SLE_ForwardDuStatus

{

sleFDS_radiated = 0,

sleFDS_interrupted = 2,

sleFDS_acknowledged = 3,

sleFDS_productionStarted = 4,

sleFDS_productionNotStarted = 5,

sleFDS_unsupportedTransmissionMode = 6,

sleFDS_invalid = -1

} SLE_ForwardDuStatus;

typedef unsigned short SLE_InvokeId;

typedef enum SLE_SlduStatusNotification

{

sleSN_produceNotification = 0,

sleSN_invalid = -1

} SLE_SlduStatusNotification;

4. 
   /* Types derived from CCSDS-SLE-TRANSFER-SERVICE-BIND-TYPES */