Click or drag to resize

MvComponent Methods

The MvComponent type exposes the following members.

Methods
  NameDescription
Protected methodAckOpenView
Called by Rogue Wave Server in order to acknowledge or rollback a view opening performed with the "acknoledged openView" method.
Public methodBeginC2STransaction
Initializes a component-to-server transaction.
Public methodBeginC2STransaction(MvComponentTransactionHandler)
Initializes a component-to-server transaction.
Public methodBeginModelDeclaration
Empty implementation of IRtModelBuilder.
Protected methodBeginS2CTransaction
Transaction Control from the Server to the Component. Called whenever a server-to-component transaction is opened.
Public methodCommitC2STransaction
Sends to the server the current component-to-server transaction.
Public methodStatic memberConnect
Lets you establish a connection with a the server identified by its name and hostname.
Public methodDeclAttribute
Empty implementation of IRtModelBuilder.
Public methodDeclClass
Empty implementation of IRtModelBuilder.
Public methodDeclFunction
Empty implementation of IRtModelBuilder.
Public methodDeclParentClass
Implementation of IRtModelBuilder.
Public methodDeclRelation
Empty implementation of IRtModelBuilder.
Public methodDelRepresentation
Called by Rogue Wave Server to delete a representation.
Public methodDisconnect
Disconnects the component from the server.
Public methodEndModelDeclaration
Empty implementation of IRtModelBuilder.
Protected methodEndS2CTransaction
Transaction Control from the Server to the Component. Called whenever a server-to-component transaction is over.
Public methodExecAsyncGlobalCallback
Callback that executes an asynchronous call to a remote function.
(Inherited from MvEndPoint.)
Public methodExecAsyncObjectCallback
Callback that executes an asynchronous call on a remote object.
(Inherited from MvEndPoint.)
Public methodCode exampleExecDuplexGlobalCallbackAsync
This function executes a global callback on the server and get its result in an asynchronous task.
Public methodCode exampleExecDuplexObjectCallbackAsync
This function executes a member callback on the server and get its result in an asynchronous task.
Public methodExecSyncGlobalCallback
Callback that executes a synchronous call to a remote function.
(Inherited from MvEndPoint.)
Public methodExecSyncObjectCallback
Callback that executes a synchronous call on a remote object.
(Inherited from MvEndPoint.)
Public methodExecUserAsyncCallback
Component Actions on the Server. Executes the callback function callbackName for the user object which is associated with the component on the server side. (The user object type should be a subtype of IlsMvUser.)
Public methodExit
Called when the component is destroyed.
Public methodGetObjectIdsAsync
Requests the list of objects that have been registered with the server and whose names match the pattern. (See IlsString::match(), see also IlsMvServer::DeclObjectLabel() to know how to associate a Server object with a label.)
Public methodGetRepresentation
Given an identifier, this method returns the associated representation, if any.
Public methodGetRpModel
Model Management. Returns the dynamic representation model identified by id, if any, or null otherwise.
Public methodGetRpObject
Returns the RpObject from a given MvRef.
Public methodGetServerModel(Boolean)
Enables the component to receive the object model specification of the server in asynchronous mode.
(Overrides MvEndPointGetServerModel(Boolean).)
Public methodGetServerModel(IRtModelBuilder, Boolean)
Request the server for the server model description.
Public methodGetViewIdsAsync
Requests from the server the list of the views that meet the criteria defined by the arguments.
Public methodGetViewTypesAsync
Queries the list of views available on a given object, according to some patterns.
Public methodLoadViewSpec
Loads a dynamic view-type specification to the server.
(Inherited from MvEndPoint.)
Public methodNewInCollector(RpObject, Int32, Boolean)
Lets you create a new representation object associated with a collector attribute.

On the server side, this new representation object will be associated with a new Server object, which itself will be included in the relation specified by the collector.

The method determines the representation object type associated with the collector in the view specification. It calls the constructor of this object type and calls the function OnAddToCollection(RpObject, Int32) with collectorOwner and collectorId as parameters on the new object.

Then, if the endUpdate is true, the method EndC2SUpdate is invoked.

Public methodNewInCollector(RpObjModel, RpObject, Int32, Boolean)
Lets you create a new representation object associated with a collector attribute.

On the server side, this new representation object will be associated with a new Server object, which itself will be included in the relation specified by the collector.

The method calls the constructor for the objModel type and calls the function OnAddToCollection(RpObject, Int32) with collectorOwner and collectorId as parameters on the new object.

Then, if the endUpdate is true, the method EndC2SUpdate is invoked.

Public methodNewMapping
Enables the component to create a new representation object associated with a collector attribute.
Public methodNewRepresentation
Called to create a new representation if no subtype of Representation is specified in the associated dynamic view type.
Public methodOnNewRpModel
Model Management. Before creating a representation for a given dynamic representation model, the object server sends a copy of this model to the component. This empty member function is called each time the component receives a new or an updated dynamic representation model. This function is empty and can be overridden.
Protected methodOnNewS2CPendingTrans
Called each time the process of a server to component transaction is postponed.

Note that the processing of a pending transaction is automatically delayed if another server-to-component transaction is already being processed.

Public methodOpenView(String, String, MvValue, Boolean)
Opens an instance of a dynamic view on a server object.
Public methodOpenView(String, String, MvValue, MvValue, Int32, Boolean)
Opens an instance of a dynamic view on a server object.
Public methodRecvMessage
Called upon reception of a message issued by the server (see IlsMvServer:ReplyMessage).
Public methodRestartS2CTrans
Restarts the processing of server-to-component transactions.
Public methodRollbackC2STransaction
Rolls back the current component-to-server transaction, previously initialized by the beginC2STransaction function.
Public methodSetIOAdapters
Sets a message encoder and decoder to the endpoint.
(Inherited from MvEndPoint.)
Public methodSuspendS2CTrans
Suspends the processing of any new transaction issued by the server.
Public methodTransactionDelegates
Returns all the transaction delegates that are waiting for a transaction.
Top
See Also