Module ocs_app

Description
Data Types
Function Index
Function Details

This application behaviour callback module starts and stops the ocs application.

Behaviours: application.

Description

This application behaviour callback module starts and stops the ocs application.

Data Types

start_type()

start_type() = normal | {takeover, node()} | {failover, node()}

Function Index

start/2	Starts the application processes.
install/0	Equivalent to `install([node() \| nodes()])`.
install/1	Initialize OCS tables.
join/1	Join an existing cluster.
start_phase/3	Called for each start phase in the application and included applications.
prep_stop/1	Called when the application is about to be shut down, before any processes are terminated.
stop/1	Called after the application has stopped to clean up.
config_change/3	Called after a code replacement, if there are any changes to the configuration parameters.
force/1*	Try to force load bad tables.
add_example_offers/0*	Seed product catalog with example offers.
create_table/2*	Create mnesia table.

Function Details

start/2

start(StartType, StartArgs) -> Result

StartType = start_type()
StartArgs = term()
Result = {ok, pid()} | {ok, pid(), State} | {error, Reason}
State = #state{}
Reason = term()

Starts the application processes.

install/0

install() -> Result

Result = {ok, Tables} | {error, Reason}
Tables = [atom()]
Reason = term()

Equivalent to install([node() | nodes()]).

install/1

install(Nodes) -> Result

Nodes = [node()]
Result = {ok, Tables} | {error, Reason}
Tables = [atom()]
Reason = term()

Initialize OCS tables. Nodes is a list of the nodes where ocs tables will be replicated.

If mnesia is not running an attempt will be made to create a schema on all available nodes. If a schema already exists on any node mnesia will be started on all nodes using the existing schema.