pub_initialize

Call this method before any other API in the Publisher API, and call it only once. Set the constant startup.version = PUB_STARTUP_VERSION before calling pub_initialize.

Syntax

uint16_t pub_initialize( PUB_STARTUP * startup_settings );

Parameters

• PUB_STARTUP * startup_settings – contains information needed by the publisher to initialize:
  • size_t version – always set to PUB_STARTUP_VERSION.
  • char * config_dir – the directory for the publisher.xml file.
  • char * template_dir – the directory for RDS templates.
  • bool strict_check – a value indicating whether strict checking should be performed on messages being built. true indicates that strict checking should be performed; Sybase suggests that you use this setting during development. false indicates that strict checking is not performed; Sybase recommends this setting for production mode.
  • bool own_logger – true if the feed handler has initialized the log file, and false if the publisher should initialize the log file.
  • char * component_subtype – a value indicating the type of publisher, for example, “FAST feed handler” or “demo feed handler.” This information is used to identify the type of publisher when displaying information in Operations Console.
  • PUB_CALLBACKS * callbacks – used to notify the Publisher API caller of events. RAP currently supports only one callback, which is a function to call if the publisher receives a request to shut down.

    The caller of the Publisher API may have to perform activities that need to occur before the Publisher API shuts down. The Publisher API invokes this callback function to notify the caller that a request to shut down has been received. The caller must perform the necessary activities and then invoke the publisher's shutdown API.

Returns

uint16_t error_code

An error code or ERR_NONE (value 0).