Basic Types
This section documents the following Rogue Wave® Server type definitions and enumerations
Summary List
IlsActivity
enum IlsActivity{
ILS_ACTIVE
ILS_INACTIVE
};
This enumerated type contains two values that indicate whether a data structure is active or not. When a data structure is set to the value ILS_ACTIVE, its modification triggers the recomputation of derived data members.
Library
See Also
IlsDerived,
IlsEntry,
IlsInvertedRelation,
IlsInvertedRelationList,
IlsOwns,
IlsOwnsDynamicArray,
IlsOwnsList,
IlsUses,
IlsUsesDynamicArray,
IlsUsesFixedArray,
IlsUsesList IlsAny
typedef void* IlsAny;
The type IlsAny can contain a pointer to any kind of information or any value that needs less than a pointer-size to be stored.
Libraries
IlsAttributeAccessor
class IlsAttributeAccessorFunctor {
public:
virtual IlsMvValue operator () (IlsViewed&) const;
};
typedef IlsAttributeAccessorFunctor* IlsAttributeAccessor;
This type is an accessor functor to the value of a non-indexed attribute. The parameter owner is the owner of the attribute. It is used by the server model interpreter.
Libraries
See Also
IlsAttributeModifier
class IlsAttributeModifierFunctor {
public:
virtual IlsBoolean operator()(IlsViewed&, IlsMvValue) const;
};
typedef IlsAttributeModifierFunctor* IlsAttributeModifier;
This type is a functor that modifies the value of a non-indexed attribute. It takes the following parameters:
owner is the owner of the attribute.
value is the value to be assigned to the attribute.
Libraries
See Also
IlsAttributeModifTest
typedef IlsBoolean (*IlsAttributeModifTest)(IlsViewed& owner);
This type is a functor used by the server model interpreter to test the modification of a non-indexed attribute. The parameter owner is the owner of the attribute.
Libraries
See Also
IlsAttributeSubscriber
class IlsAttributeSubscriberFunctor {
public:
virtual void operator()(IlsViewed&,
IlsBoolean subscribeFlag) const;
};
typedef IlsAttributeSubscriberFunctor* IlsAttributeSubscriber;
This type is a functor used by the server model interpreter to subscribe or unsubscribe to a non-indexed attribute. It takes the following parameters:
owner is the owner of the attribute.
subscribeFlag is a Boolean flag indicating whether the interpreter is subscribing or unsubscribing.
Libraries
See Also
IlsBoolean
#define IlsFalse ((IlsBoolean)0)
#define IlsTrue ((IlsBoolean)1)
The type IlsBoolean handles Boolean values. A Boolean value is true when set to IlsTrue and false when set to IlsFalse.
Libraries
IlsCallbackFunc
typedef void (*IlsCallbackFunc)(IlsAny);
This type is a pointer on a callback function that takes an IlsAny argument.
Library
IlsCardinality
The numeric type IlsCardinality indicates the minimum or maximum number of elements in a one-to-many relation.
Library
See Also
IlsC2STransStatus
Category
Dynamic view-related type definition
Signature
enum IlsC2STransStatusEnum{
ILS_C2S_NO_ROLLBACK,
ILS_C2S_NO_ACKNOWLEDGE,
ILS_C2S_NO_NOTIFY,
ILS_C2S_SV_ROLLBACK,
ILS_C2S_ALL,
ILS_C2S_DEFAULT
};
typedef unsigned short IlsC2STransStatus;
Libraries
This type definition specifies the kind of component transactions that are executed within a server. It is passed as a parameter to the function that is committing a component transaction (see the function
IlsMvComponent::commitC2SCTransaction).
This type definition is received on the server side as a parameter to the functions
IlsMvServer::beginTransaction and
IlsMvServer::endTransaction. An
IlsC2STransStatus object can be assigned one of the following values or a Boolean ORing expression on these values:
ILS_C2S_NO_ROLLBACK The component transaction must not fail and must not be rolled back even if some of its editing operations fail.
ILS_C2S_NO_ACKNOWLEDGE No acknowledgement from the server is requested on the component side when the transaction is completed.
ILS_C2S_NO_NOTIFY No notification cycle must be performed by the server after the transaction is completed.
ILS_C2S_SV_ROLLBACK ILS_C2S_ALL This value selects all the transaction optional features (rollback, acknowledgement, notification).
ILS_C2S_DEFAULT This value refers to the default component-to-server transaction status assigned via the function IlsMvComponent::setDefaultC2STransStatus.
See Also
IlsCbArgNb
typedef short IlsCbArgNb;
This type is used in callback execution functions, such as those that belong to the classes
IlsMvEndPoint,
IlsRpObject,
IlsMvComponent) to define the size of the parameter arrays, and of the size of indexes in these arrays.
Libraries
See Also
ILS_CUT_DIRECTIVE
enum ILS_CUT_DIRECTIVE{
ILS_ALL
ILS_USE
ILS_OWNERSHIP
};
This enumerated type lists the directives that can be associated with the cut function.
ILS_ALL This directive cuts all relations.
ILS_USE This directive cuts use relations only. In the case of an entity, this value is equivalent to ILS_ALL.
ILS_OWNERSHIP This directive cuts the ownership relation, if any. It does not apply to an entity.
Library
See Also
IlsDerivedEvaluatorFunction
typedef IlsMvValue (*IlsDerivedEvaluatorFunction)(IlsViewed&);
This function pointer type is used to assign an evaluation function to a derived dynamic attribute.
Library
IlsEagerness
typedef unsigned short IlsEagerness;
This type specifies the eagerness of a derived data member.
Library
See Also
IlsIdxAttributeAccessor
class IlsIdxAttributeAccessorFunctor {
public:
virtual IlsMvValue operator () (IlsViewed&, int index) const;
};
typedef IlsIdxAttributeAccessorFunctor* IlsIdxAttributeAccessor;
This type is an accessor functor to the value of an indexed attribute. It takes the following parameters:
owner is the owner of the attribute.
index is the index of the attribute.
Libraries
See Also
IlsIdxAttributeModifier
class IlsIdxAttributeModifierFunctor {
public:
virtual IlsBoolean operator()(IlsViewed&,
int index,
IlsMvValue) const;
};
typedef IlsIdxAttributeModifierFunctor* IlsIdxAttributeModifier;
This type is a functor that modifies the value of an indexed attribute. It takes the following parameters:
owner is the owner of the attribute.
index is the index of the attribute.
value is the value to be assigned to the attribute.
Libraries
See Also
IlsIdxAttributeModifTest
class IlsIdxAttributeModifTestFunctor {
public:
virtual IlsBoolean operator()(IlsViewed&, int index) const;
};
typedef IlsIdxAttributeModifTestFunctor*
IlsIdxAttributeModifTest;
This type is a functor used by the server model interpreter to test the modification of an indexed attribute. It takes the following parameters:
owner is the owner of the attribute.
index is the index of the attribute.
Libraries
See Also
IlsIdxAttributeSubscriber
class IlsIdxAttributeSubscriberFunctor {
public:
virtual void operator()(IlsViewed&,int index,
IlsBoolean subscribeFlag) const;
};
typedef IlsIdxAttributeSubscriberFunctor*
IlsIdxAttributeSubscriber;
This type is a functor used by the server model interpreter to subscribe or unsubscribe to an indexed attribute. It takes the following parameters:
owner is the owner of the attribute.
index is the index of the attribute.
subscribeFlag is a Boolean flag indicating whether the interpreter is subscribing or unsubscribing.
Libraries
See Also
IlsLogLevel
enum IlsLogLevel {
ILS_LOG_UNSET = 0,
ILS_LOG_DEBUG = 1,
ILS_LOG_WARNING = 2,
ILS_LOG_INFO = 3,
ILS_LOG_ERROR = 4,
ILS_LOG_FATALERROR = 5,
ILS_LOG_INTERNALERROR = 6,
ILS_LOG_MSG = 7,
ILS_LOG_NOTHING = 8
};
This enumerated type enumerates the various error types that can be generated by the system. Note that, by default, only errors of type ILS_LOG_WARNING and greater are displayed by the system.
Libraries
See Also
IlsMoveDirective
enum IlsMoveDirective{ILS_BEGINNING, ILS_END;}
This type contains two values that indicate the beginning and the end of a list.
Library
See Also
IlsMsgDecoder
typedef char* (*IlsMsgDecoder)(const char* buf,
unsigned long& len);
This function type is used when a message is expected from the communication layer. The incoming message of length len is in the buf argument and this function should return the new buffer that will be received and assign the new length to the len argument.
Library
IlsMsgEncoder
typedef char* (*IlsMsgEncoder)(const char* buf,
unsigned long& len);
This function type is used when a message is to be sent over the communication layer. The outcoming message of length len is in the buf argument and this function should return the new buffer that will be sent and assigned the new length to the len argument.
Library
IlsObjectConstructor
class IlsObjectConstructorFunctor{
public:
virtual IlsViewed* operator ()(IlsString) const;
};
typedef IlsObjectConstructorFunctor* IlsObjectConstructor;
This functor is used by the server model interpreter to create a new instance of a server object. The string passed as a parameter is null if the object type has no associated identifier attribute or if this identifier has not been assigned when the constructor is requested.
Libraries
See Also
IlsOpenViewStatus
typedef unsigned char IlsOpenViewStatus;
The type
IlsOpenViewStatus is used in the signature of the member functions
IlsMvServer::OpenView to define the status of a view-opening action. It is also passed as a parameter:
The possible values of the typedef
IlsOpenViewStatus are listed in the enumerated type
IlsOpenViewStatusE.
Libraries
See Also
IlsOpenViewStatusE
enum IlsOpenViewStatusE{
ILS_OPEN_OK,
ILS_ALREADY_OPENED,
ILS_OPEN_ILLEGAL_ORIGIN,
ILS_OPEN_REFUSED,
ILS_OPEN_FAILED
};
This enumerated type is used by the
IlsOpenViewStatus typedef to return the status of a view-opening action:
ILS_OPEN_OK: The view has been opened successfully.
ILS_ALREADY_OPENED: The view is already open and has not be re-opened.
ILS_OPEN_ILLEGAL_ORIGIN: The view has not be opened because the origin object was not valid.
ILS_OPEN_REFUSED: The opening of the view has been refused (see the function
IlsViewed::acceptView for more information.)
ILS_OPEN_FAILED: The view has not been opened for other reasons (unknown view type, rollback of transaction).
Libraries
See Also
IlsRefCount
This numeric type stores reference counters.
Libraries
See Also
IlsRelationAccessor
class IlsRelationAccessorFunctor {
public:
virtual IlsViewedRel* operator() (IlsViewed&) const;
};
typedef IlsRelationAccessorFunctor* IlsRelationAccessor;
This relation accessor is a functor used by the server model interpreter. It takes the object owning the relation as a parameter.
Libraries
See Also
IlsRelationId
This numeric type identifies a relation. It is generally used to invert relations.
Library
See Also
IlsRelationModifier
class IlsRelationModifierFunctor {
public:
virtual IlsBoolean operator()(IlsViewed&, IlsViewed*) const;
};
typedef IlsRelationModifierFunctor* IlsRelationModifier;
This type is a functor used by the server model interpreter to modify a relation and takes the following parameters:
owner is the owner of the relation.
target is a pointer to the new target (unary relation) or to a target to be inserted or extracted (n-ary relations).
Libraries
See Also
IlsRepresentationId
typedef unsigned long IlsRepresentationId;
This numeric type is used to identify a representation.
Libraries
See Also
IlsRpAttributeId
typedef short IlsRpAttributeId;
This numeric type is used to identify a representation object attribute or a representation object model attribute.
Libraries
See Also
IlsRpModelId
typedef unsigned short IlsRpModelId;
This numeric type is used to identify a representation model.
Libraries
See Also
IlsRpObjectId
typedef unsigned long IlsRpObjectId;
This numeric type is used to identify a representation object.
Libraries
See Also
llsRpObjModelId
typedef unsigned short IlsRpObjModelId;
This numeric type is used to identify a representation object model.
Libraries
See Also
IlsRpStatus
typedef unsigned short IlsRpStatus;
This type is used to specify the representation status of a server object in a view.
Libraries
See Also
IlsRpUpdateEnum
enum IlsRpUpdateEnum{
ILS_RP_CREATION,
ILS_RP_MODIFICATION,
ILS_RP_DELETION
};
This enumerated type is used to indicate the type of editing operation to be performed on a server object by a component through a dynamic view. See the member functions
IlsViewed::beginEdition and
IlsViewed::endEdition for details.
The meaning of the values is:
ILS_RP_CREATION: The server object has been created.
ILS_RP_MODIFICATION: The server object has been modified.
ILS_RP_DELETION: The server object has been removed.
This enumerated type contains also other values that are only used internally by the dynamic view server protocol.
Library
See Also
IlsRpUpdateType
typedef int IlsRpUpdateType;
This type definition is used to indicate what types of editing operations are performed on a server object by a component through a dynamic view. Its possible values are obtained by using
OR expressions with the values of the enumerated type
IlsRpUpdateEnum. See the member functions
IlsViewed::beginEdition and
IlsViewed::endEdition for details.
Library
See Also
IlsRTFunction
class IlsRTFunctionFunctor
{
public:
virtual IlsMvValue operator ()(void* ptr,
const IlsMvValue* values,
int dim) const;
};
typedef IlsRTFunctionFunctor* IlsRTFunction;
This type is a functor to access to member functions or global functions. It is used by the server model interpreter and takes the following parameters:
ptr is a pointer to the object on which the member function applied or a null pointer if the function is a global function.
value is a pointer to an array of values that are used to assign the function parameters.
dim is the dimension of this array.
Libraries
See Also
IlsRTFunctionPtr
typedef IlsMvValue (*IlsRTFunctionPtr)
(void*,
const IlsMvValue*,
int dim);
This type is a pointer to a function that takes a non-typed object as its first parameter and an array of arguments. Functions of this type are registered with the server model interpreter to provide dynamic methods with a C++ implementation.
Libraries
See Also
IlsS2CTransStatus
Category
Dynamic view-related enumerated type (component side)
enum IlsS2CTransStatus{
ILS_S2C_ACKNOWLEDGE,
ILS_S2C_SV_ROLLBACK,
ILS_S2C_CP_ROLLBACK,
ILS_S2C_NOTIFY,
ILS_S2C_NOTIFY_CREATION
};
Libraries
This enumerated type defines the kind of incoming server transactions that are executed within a component. It is passed as a parameter at the beginning and at the end of the transactions that apply to components, representations and representation objects.
It can take different values, as follows:
ILS_S2C_ACKNOWLEDGE: acknowledgement
ILS_S2C_SV_ROLLBACK: rollback performed by the server
ILS_S2C_CP_ROLLBACK: rollback performed locally to the component
ILS_S2C_NOTIFY: notification
ILS_S2C_NOTIFY_CREATION: notification of creation
See Also
IlsSimpleTargetAccessor
class IlsSimpleTargetAccessorFunctor {
public:
virtual IlsViewed* operator ()(IlsViewed&,IlsTypeId) const;
};
typedef IlsSimpleTargetAccessorFunctor* IlsSimpleTargetAccessor;
This type is an accessor functor to the target of unary relations. It is used by the server model interpreter and takes the following parameters:
owner is the owner of the relation.
Libraries
See Also
IlsSmartViewed
typedef IlsSmartEdited IlsSmartViewed;
This type is a smart pointer to the type IlsViewed.
Library
See Also
IlsSocketCallback
typedef void (* IlsSocketCallback)(unsigned int, IlsAny);
This callback is called when something is detected on an external file descriptor registered to the MvTCP main loop or when a new MvTCP file descriptor is added or removed. The file descriptor is passed and the optional argument provided when registering the callback.
See the static member functions
AddInput,
SetCreateFDCallback or
SetRemoveFDCallback of the class
IlsTcpMvProcess.
Library
See Also
IlsSvInt
typedef int IlsSvInt;
This type definition redefines the integer attribute type. It is used to differentiate the Server indexes (which start from 1) from the Views (formerly InForm) indexes (which start from 0).
Library
See Also
IlsSwComponentCallbackType
typedef IlsBoolean(*IlsSwComponentCallbackType)(IlsSwComponent&,
IlsAny);
This is the default
IlsSwComponent callback type. If the callback returns
IlsTrue, no further callbacks are called and, if appropriate, the default action of the component is not performed.
Library
See Also
IlsSwDragDropInteractorFlag
enum IlsSwDragDropInteractorFlag {
IlsSwCanDragDrop,
IlsSwCanDoubleClick,
IlsSwCanCopyPaste,
IlsSwDragDropAllInteractions
};
This enumerated type specifies the control of the drag-and-drop interactor control that is possible.
Library
See Also
IlsSwExecCallbackType
typedef void (*IlsSwExecCallbackType)(IlvGraphic*, IlvAny);
This callback type is specified with the name @IlsRpCallback in Rogue Wave Server Studio.
Library
See Also
IlsSwInFormConverter
typedef IlsMvValue (*IlsSwInFormConverter)(const IlvSwValue&);
This type converts an Rogue Wave Views type to an Rogue Wave Server type.
Library
See Also
IlsSwOpenViewCallbackType
typedef void (*IlsSwOpenViewCallbackType)
(IlsSwRepresentation* repres,
const IlsString& viewName,
IlsAny arg);
This is the callback type for the callback called when a view is opened using member functions from the API of the Server/Rogue Wave Views mapping, such as
IlsSwComponent::openSwView,
IlsSwRow::swOnDereference, and so forth).
The status argument gives the status of the view-opening.
This callback is called by the function
IlsSwRepresentation::onCreation if opening the view has caused a new representation to be created. It can also be called by the function
IlsSwComponent::ackOpenView if the view was already open on the same origin, and has not been opened in force mode.
If the callback is called with no representation, it means that the view has not been opened on the client side, in which case the status reports why it has not been opened.
You can test whether the representation is bad using the member function
IlsSwRepresentation::isBad. A representation may be bad if its initialization failed—in most cases, because invalid parameters were passed—thus causing an alert message to be displayed to the user. If this happens, the representation will be closed just after this callback.
Note: You cannot delete the representation in this callback. |
Library
See Also
IlsSwRepresentationCallbackType
typedef IlsBoolean (*IlsSwRepresentationCallbackType)
(IlsSwRepresentation&,
IlsAny);
This is the default
IlsSwRepresentation callback type. If the callback returns
IlsTrue, no further callbacks are called and, if appropriate, the default action of the representation is not performed.
Library
See Also
IlsSwRepresentationContainerCallbackType
typedef IlsBoolean(*IlsSwRepresentationContainerCallbackType)
(IlsSwRepresentation&,
IlsAny,
IlvGadgetContainer*);
This is the
IlsSwRepresentation callback type for the Rogue Wave Views callbacks
IlvReadCallbackSymbol and
GadgetContainerInitializedCallbackSymbol. If the callback returns
IlsTrue, no further callbacks are called.
Library
See Also
IlsSwRepresentationS2CCallbackType
typedef IlsBoolean (*IlsSwRepresentationS2CCallbackType)
(IlsSwRepresentation&,
IlsAny,
IlsS2CTransStatus,
IlsTransactionId);
This is the
IlsSwRepresentation callback type for the callbacks
BeginS2CTransactionSymbol and
EndS2CTransactionSymbol. If the callback returns
IlsTrue, no further callbacks are called. You should not delete the representation itself in these callbacks.
Library
See Also
IlsSwRowCallbackType
typedef IlsBoolean (*IlsSwRowCallbackType)(IlsSwRow&, IlsAny);
This is the default
IlsSwRow callback type. If the callback returns
IlsTrue, no further callbacks are called, and if appropriate, the default action of the row representation is not performed.
Library
See Also
IlsSwServerConverter
typedef IlvSwValue (*IlsSwServerConverter)(const IlsMvValue&);
This type converts an Server type to an Rogue Wave Views type.
Library
See Also
IlsSwTableCallbackDeleteRowType
typedef IlsBoolean(*IlsSwTableCallbackDeleteRowType)
(IlsSwTable& table,
IlsAny,
IlsBoolean destroy,
IlsSwRow*& row,
IlvBoolean& returnValue);
This is the
IlsSwTable callback type for the callback
IlsSwTable::DeleteRowSymbol. This callback is called by the member function
IlsSwTable::deleteRow, which is itself called by the virtual member function
IlsSwMemoryTable::deleteRow when a row is deleted from the data source. This callback receives the following data:
table is a reference on the table that issues the deletion
arg is the parameter that has been specified when setting the callback.
The Boolean argument
destroy is
IlsTrue if the corresponding row must be deleted.
row is a pointer on the row to be deleted.
returnValue is a reference on a Boolean value that will be used as a return value for the function
IlsSwMemoryTable::deleteRow.
When this callback is called, it must set the return value to IlsTrue if the deletion is successful or IlsFalse otherwise.
If this callback returns
IlsTrue, this means that it has handled the deletion. In this case, the
deleteRow member function does not process any further action. Otherwise, Server deletes the
IlsSwRow object.
Library
See Also
IlsSwTableCallbackInsertRowType
typedef IlsBoolean (*IlsSwTableCallbackInsertRowType)
(IlsSwTable&,
IlsAny,
IlvInt rowNumber,
IliTableBuffer* buf,
IlsSwRow*& row,
IlvBoolean& returnValue);
This is the
IlsSwTable callback type for the callback
IlvSwTable::InsertRowSymbol.
When this callback is called, it must set three values.
The return value of the callback.
This must be set to
IlsFalse if the callback did nothing or is prepared to let the other callbacks, if any, be called.
If the callback returns
IlsTrue, no more callbacks are called and the action taken then depends on the return parameters
row and
returnValue, as explained below.
Additionally in this latter case, this callback receives as parameters the row number and buffer to be inserted and must set the parameters row and returnValue.
The
returnValue parameter is the value that will be used as the return value of the Rogue Wave Views member function
IliTable::insertRow.
If the callback returns a row and sets the
returnValue argument to
IlvFalse, the row in the datasource is not inserted.
If the callback sets the
returnValue argument to
IlvTrue, the row in the datasource is inserted.
The
row parameter
If non-null, this row object will be used as the new row.
If null, the table creates a new row object.
Library
See Also
IlsSwTableCallbackType
typedef IlsBoolean (*IlsSwTableCallbackType)
(IlsSwTable&,
IlsAny);
This the default
IlsSwTable callback type. If the callback returns
IlsTrue, no further callbacks are called, and if appropriate, the default action of the table representation is not performed.
Library
See Also
IlsTimerCallback
typedef void (*IlsTimerCallback)(IlsTimer&, IlsAny);
This is the signature of the timer callback that is invoked when a timer is fired. The timer being fired is passed to this method, as well as an extra argument that has been registered with the callback.
Library
See Also
IlsTransactionId
typedef unsigned long IlsTransactionId;
This numeric type is used to identify a component-to-server transaction.
Library
See Also
IlsVwConnectionPanelOpenViewCallbackType
typedef IlsBoolean (*IlsVwConnectionPanelOpenViewCallbackType)
(IlsMvComponent* component,
const IlsString& objName,
const IlsString& viewName,
IlsBoolean force,
IlsAny arg);
This is the callback type for the callback called when a view is opened using the connection panel. This type takes the following arguments:
The component on which this view is opened
The label of the server object
The name of the view
If set to
IlsTrue, the Boolean argument
force means that the user wants to open the view in force mode. See the description of the arguments to the function
IlsMvComponent::openView for more information.
If this type returns
IlsTrue, it means that you have parameterized the opening of the view. Otherwise, the connection panel opens the view using the standard
IlsMvComponent::openView member function.
Library
See Also
IlsWindowType
enum IlsWindowType {
ILS_WINDOWTYPE_CONSOLE,
ILS_WINDOWTYPE_WINDOW,
ILS_WINDOWTYPE_DEFAULT,
ILS_WINDOWTYPE_POP
};
This enumerated types specify how messages should be handled when running on a Windows® machine. The value ILS_WINDOWTYPE_CONSOLE works only if the application is compiled in the subsystem console and the values ILS_WINDOWTYPE_WINDOW and ILS_WINDOWTYPE_POP work only if the application is compiled in the subsystem windows.
Library
See Also
Version 5.8
Copyright © 2014, Rogue Wave Software, Inc. All Rights Reserved.