Evergreen DokuWiki - osrf-devel

benefits_of_opensrf_over_other_application_frameworks

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments How OpenSRF Stacks Up How does OpenSRF compare to other Application Frameworks on choice of development languages: OpenSRF J2EE Catalyst Maypole Native Perl Client X X n/a Native C Client

chop_chop_jabber

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments Chop Chop, Jabber is OpenSRF's custom lighweight Jabber server. It's designed with speed and simplicity in mind, and thus boasts roughly 2% of the XMPP () feature set. What it provides is fast XMPP message routing with little extra logic to support the wealth of XMPP options.

client_--_bootstrap.conf

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments # ---------------------------------------------------------- # Client bootstrap config file # ---------------------------------------------------------- # The default section... [bootstrap] # Base directory for all log files in the [logs] section log_dir = /opt/opensrf/log # Logging level for debugging messages # Valid settings are ERROR, INFO, DEBUG, and INTERNAL debug = ERROR # Jabber domains to connect to for services list:domains = foo.example.com, not_here.other_jabber_d…

compiling_chop_chop

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments All C/C++ code in OpenSRF can be compiled from the top level OpenSRF source directory. . See Notes on compiling C/C++ code for more info.

configuring_jabber

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments OpenSRF uses Jabber (XMPP ) as it's backbone message passing protocol. XMPP is a standard, open protocol that uses a small set of XML tags to define the message structure. There are numerous Jabber server implementations, many of which are open source and run on a variety of platforms. Initial development of OpenSRF relied solely on jabberd 2 (

example-server

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments Example Application Perl module and package implementing a math server. package MyMathServer; use OpenSRF::Application; use base 'OpenSRF::Application'; sub do_math { my $self = shift; # instance of MyMathServer my $client = shift; # instance of OpenSRF::AppRequest connected # to the client my $left_side = shift; my $op = shift; my $right_side = shift; return eval "$left_side $op $right_side"; } __PAC…

installing_software

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments OpenSRF currently contains a makefile at the top of the src directory (OpenSRF/src). This makefile can be used to build/install all of the OpenSRF components. The makefile requires a number of environment variables to be defined before the build can take place. For convenience sake, OpenSRF is presently built as a part of Open-ILS and Evergreen by a top level makefile at the root of the ILS build tree. This makefile walks you through the process of setting up the correct envir…

introduction_and_setup

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments What is OpenSRF OpenSRF is an enterprise class Service Request Framework. It's purpose is to serve as a robust message routing network upon which one may build complex, scalable applications. To that end, OpenSRF attempts to be invisible to the application developer, while providing transparent load balancing and failover with minimal overhead.

jabberd

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments Jabberd2 For full information on downloading/installing/running Jabberd2, see and . see no-store and escape patches for info on how we made jabberd2 behave like we wanted. see basic configuration for our basic config setup

language_agnostic

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments OpenSRF is Development Language Agnostic OpenSRF servers and client can be written in any language that supports network sockets. There currently exist client libraries for Perl, Python, Java, JavaScript and C, and support for C++ is planned. All client libraries share the same basic

no-store_and_escape_patches

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments OpenSRF was developed using jabberd-2.0s4. There are two patches that we applied to this source. The first patch allows a config setting which disables offline storage of messages (see ). This patch is required for OpenSRF to function. The other patch fixes a segfault in some xml entity escape code.

notes_on_compiling_c_c_code

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments There are a number of OpenSRF services written in C (currently no c++) that require compilation on install. Some of these services are required for various parts of OpenSRF to function. If necessary, a simple OpenSRF install may be performed without compiling any of the C code described below.

perl-server-dev

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments OpenSRF Application development Perl API OpenSRF offers a very simple Application development API to users of the framework. All that is required is to create a Perl module that subclasses the OpenSRF::Application package and register it's methods with the Method Dispatcher framework.

persist_server_api

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments OpenSRF Persistence Application API-Namespace The Persistence Application provides other OpenSRF Applications with a standard API for sharing and caching data. These data are stored in Slots, and there are three basic interfaces for interacting with Slots:

persist-object

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments OBJECT style Slot methods Uses the Slot in Single Object mode, storing a single object in the Slot. The OBJECT API-Namespace is useful for globally caching unique objects. opensrf.persist.object.set( slot_name, object ) Sets the value of a Slot. If the Slot has been used in STACK or QUEUE mode and opensrf.persist.object.set is called then all objects currently in the Slot will be lost.

persist-queue

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments QUEUE API-Namespace Slot methods Uses the Slot in FIFO mode, pushing values onto one end an pulling them off the other. The QUEUE API-Namespace is useful for creating an ordered message passing access point. opensrf.persist.queue.push( slot_name, object )

persist-slot

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments General Persistence Slot methods Methods used to create, use and destroy slots. opensrf.persist.slot.create( slot_name ) Creates a Persistence Slot. * Parameters: * slot_name (optional) The name of the Persistence Slot to create. If a name is not specified then the Slot is given a generic, unique name. Automatically named Slots are destroyed as soon as they are empty.

persist-stacks

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments STACK style Slot methods Uses the Slot in FILO mode, pushing and pulling objects at the same end of a list. The STACK API-Namespace is useful for creating a global Application context stack. opensrf.persist.stack.push( slot_name, object ) Adds an object to a Slot in FILO order.

primer

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

python

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

Configuring OpenSRF Python clients * Install the prerequisites * Test your installation with srfsh.py calling the math_bench test * (Optional): Connect to Prerequisites * Python 2.4+ (2.3 may work, but is untested) * pyxmpp for Jabber protocol support

running_chop_chop

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments Currently, the server takes all configuration commands from the command line. In time there will likely be a config file option as well. To run the server: /path/to/jserver-c [log_file] port : TCP port the jabber server will listen on

server_--_bootstrap.conf

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments # ---------------------------------------------------------- # Server bootstrap config file # ---------------------------------------------------------- # The default section... [bootstrap] # If this host will run the Settings server you will need # to uncomment the next line an point it at the correct file. #settings_config = /opt/opensrf/conf/opensrf.xml # Base directory for all log files in the [logs] section log_dir = /opt/opensrf/log # Logging level for debuggin…

terms

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments OpenSRF Method An exported method that logically runs in the (programming language native) namespace of the OpenSRF Application that implements it. Perl API Notes * The first parameter to an OpenSRF Method is an instance of the method's registration information, casted into the class of that method's OpenSRF Application. Remote subrequest methods are casted into the generic class OpenSRF::Application, since the local server may not have access to the actual implementation cl…

user_s_guide

Anonymous (anonymous@undisclosed.example.com) — 2022-02-10T18:34:57+00:00

User Comments OpenSRF -- The Book * Introduction and Setup * Benefits of OpenSRF over other Application Frameworks * Language Agnostic * standard message formats -- XML, JSON * persistent TCP network connections -- crosses firewalls * Notes on compiling C/C++ code * installing software * Configuring Jabber * Chop Chop, Jabber * Compiling Chop Chop * Running Chop Chop * jabberd * no-store and escape patches * basic configuration * sin…