RTI Queuing Service - Community RTI Connext Users
Contents
1. 2 2 Installing on a UNIX Based System ccccicccsccseesscicccssseesistscveosesptssteeceevasestecussssebietecdestbiacoeseseseatard spsesnss 2 3 2 3 Installing ona Windows System wv s sccieseseceseivsscecshoeseteseseeeseveststenssvautstecuevbebdusteeonstinseeess bieesueseerinnise 2 3 3 USING TNE EXGINDIOS oi iiige desainesnanassipbodedectnstidecsenraumelenatueladdienssnacxanss 3 1 A Running Queuing Service iiieisisisninnescovaveddedecosnsnannavendercudeddlesgouaaustens 4 1 4T Starting from Launcher sysssnimeni soca Beet cial Sateen peste was eosin ude fale baven A a heeee 4 1 42 Starting Manually from the Command Line cece ccc cece ceeeeseecececeeenenecesesesessnesesenenenees 4 2 43 Using Queuing Service as a Windows Service ccceccccssesssseesesesesesesesesesesesescseseseseseeesesssnseecenenens 4 4 4 3 1 Enabling Queuing Service to Run as a Windows Servic eieeeresessesseesrerhssesessesssessss 4 4 4 3 2 Running RTI Queuing Service as a Windows ServiCe cccccecse cece te cesses neseseneeeees 4 4 433 Notes when Running as a Windows Service c ccccecccccesssesescsceseseeeececseseseesssessnesesssenenenes 4 4 4 3 4 Stopping Queuing Service when it is Running as a Windows Service ereeeeeeseeeeeees 4 5 4 3 5 Disabling Queuing Service from Running as a Windows Service 0 0 0 eens 4 5 iii Chapter 1 Welcome to RTI Queuing Service RTI Queuing Service is a broker that provides a queuing communication model in2. var command line option you may need to restart your Windows machine I If you specify cfgFile in the Start Parameters field you must use the full path to the file L Some versions of Windows do not allow Windows Services to communicate with other services applications using shared memory For this reason if you plan to run Queuing Service as Windows Service you should disable the shared memory transport in all the DomainParticipants created by Queuing Service and in the applications communicating with Queuing Service For more information on setting builtin transports see the RTI Con next DDS Core Libraries User s Manual Section 15 1 Builtin Transport Plugins L In some scenarios you may need to add a multicast address e g builtin udpv4 239 255 0 1 to your discovery peers For details on setting the discovery peers see the RTI Connext DDS Core Libraries Getting Started Guide Section 4 1 2 How to Set Your Dis covery Peers Stopping Queuing Service when it is Running as a Windows Service To stop Queuing Service when it is running as a Windows Service use this command sc rtiqueuingservice520 stop You can also start stop Queuing Service from the Windows Services Control Manager From the Start menu select Control Panel Administrative Services Services Click on the service in the list then right click to select Start or Stop Disabling Queuing Service from Running as a Windows Service To remove Queuing Service
3. described in Paths Mentioned in Docu mentation Section 2 1 is 2 From the Services tab select ee Queuing Service Database Queuing Service Integration 3 In the resulting dialog use the sign to add the rtipkg file rog that you want to install 4 Click Install From the command line cd lt NDDSHOME gt bin rtipkginstall lt path to rtipkg file gt If you want to install Queuing Service without user interaction unattended mode use the u flag when installing from the command line cd lt NDDSHOME gt bin rtipkginstall u lt path to rtipkg file gt Queuing Service will be installed in the lt NDDSHOME gt directory see Paths Mentioned in Docu mentation Section 2 1 2 4 Chapler3 Using the Examples Queuing Service includes two examples to show its most relevant functionality L hello world A Hello World application in which is shown how to send receive sam ples from to Queuing Service The example also shows how to use other relevant features such as persistence and replication L remote_config A Remote Configuration example in which is shown how to remotely create delete resources query their status get a message or flushing SharedReader Queues This example uses the Request Reply API The examples are in lt path to examples gt queuing_service lt language gt where lt path to exam ples gt is described in Paths Mentioned in Documentation Section 2 1 and lt l
4. example on Windows 7 the folder is C Users your user name Documents on Windows Server 2003 the folder is C Documents and Settings your user name Documents You can specify a different location for the rti_workspace directory See the RTI Connext DDS Core Libraries Getting Started Guide for instructions lt path to examples gt Examples are copied into your home directory the first time you run RTI Launcher or any script in lt NDDSHOME gt bin This document refers to the location of these examples as lt path to examples gt Wherever you see lt path to examples gt replace it with the appropri ate path By default the examples are copied to rti_workspace version examples So the paths are e Mac OS X systems Users your user name rti_workspace version examples e UNIX based systems home your user name rti_workspace version examples e Windows systems your Windows documents folder rti_workspace version examples Note your Windows documents folder is described above You can specify that you do not want the examples copied to the workspace See the RTI Connext DDS Core Libraries Getting Started Guide for instructions 2 2 Installing on a UNIX Based System 2 2 2 3 Installing on a UNIX Based System Install Queuing Service on top of Connext DDS There are two ways to install it from RTI Launcher or from the command line From RTI Launcher z rti RTI Connext Launcher 5 2 0 bbas 1 Start R
5. OME gt bin rtiqueuingservice installService By default Queuing Service is installed with the service name rtiqueuingservice520 If you want to install it with a different service name you can use the serviceName flag For instance you would enter this all on one line lt NDDSHOME gt bin rtiqueuingservice installService serviceName mycustomservicename Using the serviceName parameter with different names allows you to install multiple Queuing Service instances on the same host Running RTI Queuing Service as a Windows Service If you added Queuing Service as a Windows Service and want to run it without rebooting you can start it as a service from the command line with the Windows sc utility sc lt serviceName gt start By default it will start Queuing Service with the defaultService configuration that is stored in lt NDDSHOME gt resource xml RTI_LQUEUING_SERVICE xml This configuration contains a service running with an empty SharedSubscriber with remote administration and monitoring enabled If you want to start Queuing Service with different parameters you can use the utility nssm You can specify the parameters from the command line by setting the option AppParameters For example you would enter this all on one line SNDDSHOMES resource app bin x64Win64VS2008 nssm exe set lt serviceName gt AppParameters lt queuing service arguments gt For more information and examples see Notes when Running as a Windows
6. RTI Queuing Service Getting Started Guide Version 5 2 0 t Your systems Working as one 2014 2015 Real Time Innovations Inc All rights reserved Printed in U S A ast printing June 2015 Trademarks Real Time Innovations RTI NDDS RTI Data Distribution Service DataBus Connext Micro DDS the RTI logo 1RTI and the phrase Your ees Working as one are registered trademarks trademarks or service marks of Real Time Innovations Inc All other trademarks belong to their respective owners Copy and Use Restrictions ia of this publication may be reproduced stored in a retrieval system or transmitted in any form Gncluding electronic mechanical photocopy and facsimile without the prior written permission of Real Time Innovations Inc The software described in this cen Bin is furnished under and subject to the RTI software license agreement The software may be used or copied only under the terms of the license agreement Technical Support Real Time Innovations Inc 232 East Java Drive Sunnyvale CA 94089 Phone 408 990 7444 Email support rti com Website https support rti com Contenis Welcome to RTI QUEUING SCIViIC eet ce eeeeeeeeeeeeeeeeeeeeeeeeeeees 1 1 2 installing Queuing Service sis isa sispncsaeccnaiidedianenwnievereideredderevnectnnns 2 1 2 1 Paths Mentioned in Documentation ccccccccessssssescesceesecssessecsecsseaecsssesscesesceseeeseeeeecseeseecaecsseesseerees 2 1
7. Service Section 4 3 3 Additionally you can start Queuing Service from the Windows Services Control Manager From the Start Menu select Control Panel Administrative Services Services Click on the service in the list then right click to select Start Notes when Running as a Windows Service Here are some things to consider when running Queuing Service as a Windows Service L All AppParameters arguments must be enclosed in quotation marks To refer to variables in the XML configuration file use the Queuing Service command line option var to set the variable s value The syntax for referring to a variable in the XML file is lt name gt S NAME lt name gt 4 4 Using Queuing Service as a Windows Service 4 3 4 4 3 5 L For the AppParameters passed to nssm use var like this var MY_DOMAIN 10 For example you would enter this all on one line SNDDSHOMES resource app bin x64Win64VS2008 nssm exe set rtiqueuingservice520 AppParameters cfgFile C dir with spaces qsconf with vars xml cfgName MyCustomConf var MY DOMAIN 10 I If a variable value includes spaces you must enclose the value in escaped quotes For example you would enter this all on one line SNDDSHOMES resource app bin x64Win64VS2008 nssm exe set rtiqueuingservice520 AppParameters cfgFile C dir with spaces qsconf with vars xml cfgName MyCustomConf var NAME My QS name I If you use environment variables instead of the
8. TI Launcher from the Tools services t command line Third Party Help _ Installation Code Generator DDS Ping DDS Spy Type Convert cd lt NDDSHOME gt bin rtilauncher lt NDDSHOMF gt is described in Paths Mentioned in Docu mentation Section 2 1 2 From the Utilities tab select RTI Package Installer 3 In the resulting dialog use the pecora convert Aa z jr Dergi sign to add the rtipkg file that you want to install gt Log 4 Click Install From the command line cd lt NDDSHOME gt bin rtipkginstall lt path to rtipkg file gt If you want to install Queuing Service without user interaction unattended mode use the u flag when installing from the command line cd lt NDDSHOME gt bin rtipkginstall u lt path to rtipkg file gt Queuing Service will be installed in the lt NDDSHOME gt directory see Paths Mentioned in Docu mentation Section 2 1 Installing on a Windows System Install RTI Queuing Service on top of RTI Connext DDS There are two ways to install it from RTI Launcher or from the command line 2 3 Installing on a Windows System From RTI Launcher 1 Start RTI Launcher from the i Third Party Help _ Installation Start menu or the command ine G line a gt cd lt NDDSHOME gt bin 4 4 rtilauncher Routing Service Recording Service Replay Service Persistence Service lt NDDSHOME gt is
9. anguage gt is c for C or cs for NET There are some differences between the versions L The NET hello world example uses the Queuing Service wrapper API while the C example uses DataWriters and DataReaders directly to interact with Queuing Service since the wrapper API is not available for C L The NET hello world example uses two SharedReaderQueues a request and a reply SharedReaderQueue The C example only uses a request SharedReaderQueue I The NET hello world example is also a performance test measuring requests and replies per second The C version sends one message per second By default the NET hello_world example s SharedReaderQueues use different types than the C example Because of these differences you will need to make some modifications in the examples in order for a hello_world C Producer to interoperate with a hello_world NET Replier and vice versa To run the examples please follow the instructions in the README txt file included in the example s directory 3 1 Chapter 4 Running Queuing Service Queuing Service runs as a separate application The script to run the executable is in lt NDDSHOME gt bin There are four ways to start Queuing Service I Starting from Launcher Section 4 1 I Starting Manually from the Command Line Section 4 2 I Using Queuing Service as a Windows Service Section 4 3 If you are starting Queuing Service as a Windows Service also read Notes when Runn
10. from the list of Windows Services on your system run this command in a terminal with Administrator privileges lt NDDSHOME gt bin rtiqueuingservice uninstallService By default the service rtiqueuingservice520 is uninstalled If you want to uninstall a different service instance add the serviceName option to the above command 4 5
11. ing as a Windows Service Section 4 3 3 4 1 Starting from Launcher 1 Start RTI Launcher from the Start menu on Windows systems or on the command line type lt NDDSHOME gt bin rtilauncher 2 From the Services tab select Queuing Service Third Party Help _ Installation JOE Routing Service Recording Service Replay Service Persistence Service 5 aA 4 1 Starting Manually from the Command Line 4 2 Starting Manually from the Command Line To start Queuing Service enter cd lt NDDSHOME gt bin rtiqueuingservice options Example cd lt NDDSHOME gt bin rtiqueuingservice cfgFile example xml cfgName QueuingService 1 Table 4 1 describes the command line options Table 4 1 RTI Queuing Service Command Line Options Option Description appName lt name gt Assigns a name to the execution of Queuing Service Remote commands will refer to the queuing service using this name In addition the name of DomainParticipants created by Queuing Service will be based on this name Default The name given with cfgName if present otherwise it is RTI_Queuing_ Service cfgFile lt name gt Specifies a configuration file to be loaded This parameter is required See Section 3 1 How to Load the XML Configuration in the Queuing Ser vice User s Manual cfgName lt name gt Specifies a configuration name Queuing Service will look f
12. ministrator privileges lt your home directory gt rti_connext_dds version e Windows systems user with Administrator privileges C Program Files rti_connext_dds version for 64 bits machines or C Program Files x86 rti_connext_dds version for 32 bit machines You may also see NDDSHOME or NDDSHOME which refers to an environment variable set to the installation path Wherever you see lt NDDSHOME gt used in a path replace it with your installation path Note for Windows Users When using a command prompt to enter a command that includes the path C Program Files or any directory name that has a space enclose the path in quotation marks For example 2 1 Paths Mentioned in Documentation C Program Files rti_connext_dds version bin rtiddsgen or if you have defined the NDDSHOME environment variable SNDDSHOMES bin rtiddsgen RTI Workspace directory rti_workspace The RTI Workspace is where all configuration files for the applications and example files are located All configuration files and examples are copied here the first time you run RTI Launcher or any script in lt NDDSHOMED gt bin The default path to the RTI Work space directory is e Mac OS X systems Users your user name rti_workspace e UNIX based systems home your user name rti_workspace e Windows systems your Windows documents folder rti_workspace Note your Windows documents folder depends on your version of Windows For
13. or a matching lt queuing_service gt tag in the configuration file This parameter is required unless cfgRemote is used cfgRemote Specifies that the initial configuration of the service must be obtained remotely from other running instances Using this option also requires the use of remoteAdministrationDo mainId to enable remote administration because the initial configuration will be received in the remote administration domain ID If you use this option and cfgName the service will wait until a configu ration with that name is received Otherwise the service will use the first configuration that it receives If the service does not receive the initial configuration after a configurable timeout see cfgRemoteTimeout it will load the configuration from the input configuration file s cfgRemoteTimeout lt n gt Specifies the maximum amount of time in seconds that Queuing Service will wait for an initial configuration when using cfgRemote Default 20 seconds daemon Runs Queuing Service as a daemon Windows service When this flag is present Queuing Service will start in the background Note that some sys tems may require special privileges to do this domainIdBase lt ID gt Sets the base domain ID This value is added to the domain IDs in the configuration file For exam ple if you set domainIdBase to 50 and use domainIDs 0 and 1 in the con figuration file then Queuing Service will
14. t name gt lt value gt Sets the value of the variable lt name gt This variable can be referenced within the XML configuration files using the lt name gt notation See Sec tion 3 4 Using Variables in XML in the Queuing Service User s Manual for more information on configuration variables You may have more than one var flag on the command line On Windows platforms you will need to put quotation marks around the variable name and value like this var MY VAR myvalue verbosity lt n gt Controls what type of messages are logged 0 Silent 1 Exceptions Connext DDS and Queuing Service default 2 Warnings Queuing Service 3 Information Queuing Service 4 Warnings Connext DDS and Queuing Service 5 Tracing Queuing Service 6 Tracing Connext DDS and Queuing Service Each verbosity level n includes all the verbosity levels smaller than n version Prints the Queuing Service version number Using Queuing Service as a Windows Service 4 3 4 3 1 4 3 2 4 3 3 Using Queuing Service as a Windows Service Windows Services automatically run in the background when the system reboots Enabling Queuing Service to Run as a Windows Service If you want to run Queuing Service as a Windows Service you must install it as such before run ning it To install it as a Windows Service run the following command in a terminal with Administrator privileges lt NDDSH
15. use domains 50 and 51 Default 0 help Displays help information 4 2 Starting Manually from the Command Line Table 4 1 RTI Queuing Service Command Line Options Option Description remoteAdministrationDomainId Enables remote administration and sets the domain ID for remote commu nication When remote administration is enabled Queuing Service will create a DomainParticipant Publisher Subscriber DataWriter and DataReader in the designated domain See Chapter 5 Administering Queuing Service from a Remote Location in lt ID gt the Queuing Service User s Manual This option overrides the value of the tag lt domain_id gt within a lt admin istration gt tag This parameter is required when using cfgRemote Default Remote administration is not enabled unless it is enabled from the XML file Specifies a name prefix to use with all files created by Queuing Service persistentFilePrefix This option overrides the value of the tag lt file_prefix gt within lt persistence_settings gt lt filesystem gt Default Value in lt persistence_settings gt lt filesystem gt lt file_prefix gt persistentStoragePath Configures the directory for persistent storage This option overrides the value of the tag lt directory gt within lt persistence_settings gt lt filesystem gt Default Value in lt persistence_settings gt lt filesystem gt lt directory gt var l
16. which a sam ple is stored in a queue until it is consumed by one QueueConsumer If there are no QueueCon sumers available when the sample is sent the sample is kept in the queue until a QueueConsumer is available to process it If a QueueConsumer receives a sample and does not acknowledge it before a specified amount of time or acknowledges it negatively the sample will be redelivered to a different QueueConsumer Queuing Service provides an at most once and at least once delivery semantic By default Queuing Service keeps the samples in memory To provide fault tolerance Queuing Service can be configured to keep the samples on disk For high availability Queuing Service provides mechanisms to replicate its state so that samples can survive the loss of any particular service and or computer 1 1 Chapler2 Installing Queuing Service This chapter describes J Paths Mentioned in Documentation Section 2 1 LI Installing on a UNIX Based System Section 2 2 I Installing on a Windows System Section 2 3 2 1 Paths Mentioned in Documentation The documentation refers to L lt NDDSHOME gt This refers to the installation directory for Connext DDS The default installation paths are e Mac OS X systems Applications rti_connext_dds version e UNIX based systems non root user home your user name rti_connext_dds version e UNIX based systems root user opt rti_connext_dds version e Windows systems user without Ad
Download Pdf Manuals
Related Search