Version 8.0 SEARCH   CONTENTS   |   PDF PAGE   PDF BOOKS   |   HOME   UP   PREV   NEXT
 —  EntireX Developer's Kit  —

Command and Info Services IDLs

The Broker-internal RPC CIS Server provides the Command and Information Services using the Remote Procedure Call (RPC) protocol.

Two CIS IDL filess are available in directory EntireX\etc\idl.

RPC CIS is a complete implementation of the Command and Information Services.

The document Broker CIS Data Structures includes a description of the CIS API. The names of the fields can also be found in the IDL (with case-insensitive and insignificant modifications).

Service Names of CIS Version 5 For Services IDL Files
SAG/ETBCIS/SAGCCV5 Command Services SagCmdServiceV5.idl
RPC/SAGCCV5/CALLNAT
SAG/ETBCIS/SAGCIV5 Information Services SagInfServiceV5.idl
RPC/SAGCIV5/CALLNAT

Command Service IDL

File SagCmdServiceV5.idl provides the interface description for all Command Services.

.NET / Java Reference

The .NET prototypes can be found in the generated .NET file SAGCCV5.cs. The Java prototypes can be found in the generated Java file SagCmdServiceV5.java.

You cannot execute cmdShutdownBroker in a none-secure mode. 

public int cmdTraceOn(short option);
public int cmdTraceOnBroker(short option);
public int cmdTraceOnPsf(short option);
public int cmdTraceOnSecurity(short option);
public int cmdTraceOff();
public int cmdTraceOffBroker();
public int cmdTraceOffPsf();
public int cmdTraceOffSecurity();
public int cmdShutdownBroker();

public int cmdShutdownParticipant(byte[] puid, String uid, String token);
public int cmdShutdownParticipantQuiesce(byte[] puid, String uid, String token);
public int cmdShutdownServer(byte[] puid, String uid, String token);
public int cmdShutdownServerQuiesce(byte[] puid, String uid, String token);

public int cmdPurge(String uowid);
public int cmdAllow();
public int cmdForbid();

public int cmdSubscribe(String uid, String token, String topic);
public int cmdUnsubscribe(String uid, String token, String topic);

public int cmdConnectPStore();
public int cmdDisconnectPStore();

public int cmdSetCmdLogFilter(String uid, String classname, String servername, String servicename, CString topic);

public int cmdClearCmdLogFilter(String uid, String Classname, String servername, String servicename, CString topic);

public int cmdEnableCmdLogFilter(String uid, String Classname, String servername, String servicename, CString topic);

public int cmdDisableCmdLogFilter(String uid, String Classname, String servername, String servicename, CString topic);

public int cmdEnableCmdLog();
public int cmdDisableCmdLog();
public int cmdSwitchCmdLog();

public int cmdProduceStatistics();

public int cmdEnableAccounting();
public int cmdDisableAccounting();

public int cmdResetUser(short option);

public int cmdNoOperation();

Top of page

Info Service IDL

File SagInfServiceV5.idl provides the interface description for all Information Services. The following functions are used to receive an unbounded array of the corresponding Broker Information Service.

See also section Using Unbounded Arrays in Writing Advanced Applications with the C Wrapper.

.NET Reference

The .NET prototypes can be found in the generated .NET file SAGCIV5.cs. 

public int infoServer(
    SoftwareAG.EntireX.NETWrapper.Generated.SAGCIV5.Structs.InfoCs[] infserver,
    String uid, byte[] puid, String token, 
    String serverclass, String servername, String servicename);

public int infoClient(
    SoftwareAG.EntireX.NETWrapper.Generated.SAGCIV5.Structs.InfoCs[] infclient,
    String uid, byte[] puid, String token);

public int infoParticipant(
    SoftwareAG.EntireX.NETWrapper.Generated.SAGCIV5.Structs.InfoCs[] infparticipant,
    String uid, byte[] puid, String token);

public int infoConversation(
    SoftwareAG.EntireX.NETWrapper.Generated.SAGCIV5.Structs.InfoCv[] infconverstaion,
    String uid, byte[] puid, String token, String serverclass, 
    String servername, String servicename, String convid):

public int infoService(
    SoftwareAG.EntireX.NETWrapper.Generated.SAGCIV5.Structs.InfoSv[] infservice,
    String uid, byte[] puid, String token,
    String serverclass, String servername, String servicename);

public int infoBroker( 
    SoftwareAG.EntireX.NETWrapper.Generated.SAGCIV5.Structs.InfoBrk[] infbroker,
);

public int infoWorker(      
    SoftwareAG.EntireX.NETWrapper.Generated.SAGCIV5.Structs.InfoBrk[] infworker,
    String uid, byte[] puid, String token);

public int infoPsf(
    SoftwareAG.EntireX.NETWrapper.Generated.SAGCIV5.Structs.InfoPsf[] infpsf,
    String uid, byte[] puid, String token);

public int infoPsfAda(
    SoftwareAG.EntireX.NETWrapper.Generated.SAGCIV5.Structs.InfoPsfada[] infpsfada
);

public int infoPsfDiv(
    SoftwareAG.EntireX.NETWrapper.Generated.SAGCIV5.Structs.InfoPsfdiv[] infpsfdiv
);

public int infoPsfFile(
    SoftwareAG.EntireX.NETWrapper.Generated.SAGCIV5.Structs.InfoPsffile[] infpsfFile
);

public int infoPsfCTree(    
    SoftwareAG.EntireX.NETWrapper.Generated.SAGCIV5.Structs.InfoPsfctree[] infpsfctree
);

public int infoSubscriber(
    SoftwareAG.EntireX.NETWrapper.Generated.SAGCIV5.Structs.InfoSubscriber[] infsubscriber,
    String uid, byte[] puid, String token, String topic);

public int infoPublisher(      
    SoftwareAG.EntireX.NETWrapper.Generated.SAGCIV5.Structs.InfoPublisher[] infpublisher,
    String uid, byte[] puid, String token);

public int infoPublication(
    SoftwareAG.EntireX.NETWrapper.Generated.SAGCIV5.Structs.InfoPublication[] infpublication,
    String publicationid);

public int infoTopic(    
    SoftwareAG.EntireX.NETWrapper.Generated.SAGCIV5.Structs.InfoTopic[] inftopic,
    String uid, byte[] puid, String token, String topic);

public int infoTcp(  
    SoftwareAG.EntireX.NETWrapper.Generated.SAGCIV5.Structs.InfoTcp[] inftcp
);

public int infoSecurity(  
    SoftwareAG.EntireX.NETWrapper.Generated.SAGCIV5.Structs.InfoSecurity[] infsecurity
);

public int infoSSL(   
    SoftwareAG.EntireX.NETWrapper.Generated.SAGCIV5.Structs.InfoSsl[] infssl
);

public int infoCmdLogFilter( 
    SoftwareAG.EntireX.NETWrapper.Generated.SAGCIV5.Structs.InfoCmdlogfilter[] infcmdlogfilter
);

public int infoNet(   
    SoftwareAG.EntireX.NETWrapper.Generated.SAGCIV5.Structs.InfoNet[] infnet
);

Java Reference

The Java prototypes can be found in the generated Java file SagInfServiceV5.java.

The following functions are used to receive an unbounded array of the corresponding Broker Information Service.

See also section Using Unbounded Arrays in Writing Advanced Applications with the C Wrapper. 

public int infoServer(String uid, byte[] puid, String token, String serverclass, String servername, String servicename);

public int infoClient(String uid, byte[] puid, String token);

public int infoParticipant(String uid, byte[] puid, String token);

public int infoConversation(String uid, byte[] puid, String token, String serverclass, 
String servername, String servicename, String convid):

public int infoService(String uid, byte[] puid, String token, String serverclass, String servername, String servicename);

public int infoBroker();

public int infoWorker(String uid, byte[] puid, String token);

public int infoPsf(String uid, byte[] puid, String token);
public int infoPsfAda();
public int infoPsfDiv();
public int infoPsfFile();
public int infoPsfCTree();

public int infoSubscriber(String uid, byte[] puid, String token, String topic);
public int infoPublisher(String uid, byte[] puid, String token);
public int infoPublication(String publicationid);
public int infoTopic(String uid, byte[] puid, String token, String topic);

public int infoTcp();
public int infoSecurity();
public int infoSSL();
public int infoCmdLogFilter();
public int infoNet();

Top of page

Examples

The following examples are available:

.NET CIS Client Example

The .NET CIS Client Example can be found in the examples directory NET WRAPPER\client\SagCisClient.cs. The directory includes the source file SagCisClient.cs and the README.TXT.

Information required to prepare and configure the EntireX Workbench:

Information required to to write a .NET CIS Client:

Build steps:

  1. Prepare Eclipse.

  2. Start Eclipse.

  3. Create a new Java Project.

  4. Add files SagCmdServiceV5.idl and SagInfServiceV5.idl to the project.

  5. Generate the .NET RPC Client from SagCmdServiceV5.idl using context menu.

  6. Generate the .NET RPC Client from SagInfServiceV5.idl using context menu.

  7. Start Visual Studio.

  8. Create a new Visual Studio Project. (.NET Console Application).

  9. Insert the generated sources SAGCCV5.cs and SAGCIV5.cs.

  10. Delete Program.cs.

  11. Insert .NET example file SagCisClient.cs to the project.

  12. Add Reference (Common Files\Software AG\SoftwareAG.EntireX.NETWrapper.Runtime.dll).

  13. Build the solution.

  14. Start the .NET CIS Client.

Java CIS Client Example

The Java CIS Client Example can be found in the examples directory EntireX\Examples\Java WRAPPER\client\mainSagCisClient.java. This directory includes the source file mainSagCisClient.java and the README.TXT.

Information required to prepare and configure the EntireX Workbench:

Information required to to write a Java CIS Client:

Build steps:

  1. Prepare Eclipse.

  2. Start Eclipse.

  3. Create a new Java Project.

  4. Add files SagCmdServiceV5.idl and SagInfServiceV5.idl to the project.

  5. Add source file mainSagCisClient.java to the project.

  6. Generate the Java RPC Client from SagCmdServiceV5.idl using the context menu.

  7. Generate the Java RPC Client from SagInfServiceV5.idl using the context menu.

  8. Build the Java CIS Client project.

  9. Start the Java CIS Client.

Top of page

 www.softwareag.com  Copyright © Software AG 1997-2008. All rights reserved.  SEARCH   CONTENTS   |   PDF PAGE   PDF BOOKS   |   HOME   UP   PREV   NEXT