- Site Map

To see an alphabetical site map click here

Applications
7 Applications This chapter should be read in conjunction with app(4) and application(3) . 7.1 Application Concept When we have written code implementing some specific functionality, we might want to...
Appup Cookbook
12 Appup Cookbook This chapter contains examples of .appup files for typical cases of upgrades/downgrades done in run-time. 12.1 Changing a Functional Module When a change has been made to a...
Overview
1 Overview The OTP Design Principles is a set of principles for how to structure Erlang code in terms of processes, modules and directories. 1.1 Supervision Trees A basic concept in Erlang/OTP is the...
Distributed Applications
9 Distributed Applications 9.1 Definition In a distributed system with several Erlang nodes, there may be a need to control applications in a distributed manner. If the node, where a certain...
Gen_Event Behaviour
4 Gen_Event Behaviour This chapter should be read in conjunction with gen_event(3) , where all interface functions and callback functions are described in detail. 4.1 Event Handling Principles In...
Gen_Fsm Behaviour
3 Gen_Fsm Behaviour This chapter should be read in conjunction with gen_fsm(3) , where all interface functions and callback functions are described in detail. 3.1 Finite State Machines A finite state...
Gen_Server Behaviour
2 Gen_Server Behaviour This chapter should be read in conjunction with gen_server(3) , where all interface functions and callback functions are described in detail. 2.1 Client-Server Principles The...
Included Applications
8 Included Applications 8.1 Definition An application can include other applications. An included application has its own application directory and .app file, but it is started as part of the...
OTP Design Principles
OTP Design Principles Version 5.6.3 Bibliography | Glossary | Cover | Top Table of Contents 1 Overview 1.1 Supervision Trees 1.2 Behaviours 1.3 Applications 1.4 Releases 1.5 Release Handling 2...
OTP Design Principles
This documentation requires a browser that can handle frames
Release Handling
11 Release Handling 11.1 Release Handling Principles An important feature of the Erlang programming language is the ability to change module code in run-time, code replacement , as described in...
Releases
10 Releases This chapter should be read in conjuction with rel(4) , systools(3) and script(4) . 10.1 Release Concept When we have written one or more applications, we might want to create a complete...
Sys and Proc_Lib
6 Sys and Proc_Lib The module sys contains functions for simple debugging of processes implemented using behaviours. There are also functions that, together with functions in the module proc_lib ,...
Supervisor Behaviour
5 Supervisor Behaviour This section should be read in conjunction with supervisor(3) , where all details about the supervisor behaviour is given. 5.1 Supervision Principles A supervisor is...
Advanced
9 Advanced 9.1 Memory A good start when programming efficiently is to have knowledge about how much memory different data types and operations require. It is implementation-dependent how much memory...
Constructing and matching binaries
4 Constructing and matching binaries In R12B, the most natural way to write binary construction and matching is now significantly faster than in earlier releases. To construct at binary, you can...
Benchmark Results
Benchmark Results call_bm Test 5.4 BEAM local_call 1.00 external_call 1.08 fun_call 2.79 apply_fun 3.54 apply_mfa_implicit 7.76 apply_mfa_explicit 8.21 Source for call_bm.erl
Common Caveats
3 Common Caveats Here we list a few modules and BIFs to watch out for, and not only from a performance point of view. 3.1 The regexp module The regular expression functions in the regexp module are...
Functions
6 Functions 6.1 Pattern matching Pattern matching in function head and in case and receive clauses are optimized by the compiler. With a few exceptions, there is nothing to gain by rearranging...
Introduction
1 Introduction 1.1 Purpose Premature optimization is the root of all evil. -- D.E. Knuth Efficient code can be well-structured and clean code, based on on a sound overall architecture and sound...
List handling
5 List handling 5.1 Creating a list Lists can only be built starting from the end and attaching list elements at the beginning. If you use the ++ operator like this List1 ++ List2 you will create a...
The Eight Myths of Erlang Performance
2 The Eight Myths of Erlang Performance Some truths seem to live on well beyond their best-before date, perhaps because "information" spreads more rapidly from person-to-person faster than a single...
Processes
8 Processes 8.1 Creation of an Erlang process An Erlang process is lightweight compared to operating systems threads and processes. A newly spawned Erlang process uses 309 words of memory in the...
Profiling
10 Profiling 10.1 Do not guess about performance - profile Even experienced software developers often guess wrong about where the performance bottlenecks are in their programs. Therefore, profile...
Tables and databases
7 Tables and databases 7.1 Ets, Dets and Mnesia Every example using Ets has a corresponding example in Mnesia. In general all Ets examples also apply to Dets tables. 7.1.1 Select/Match operations...
Windows NT
2 Windows NT This chapter describes the OS specific parts of OTP which relate to Windows NT. 2.1 Introduction A normal installation of NT 4.0, with service pack 4 or later, is required for an...
Embedded Solaris
1 Embedded Solaris This chapter describes the OS specific parts of OTP which relate to Solaris. 1.1 Memory Usage Solaris takes about 17 Mbyte of RAM on a system with 64 Mbyte of total RAM. This...
VxWorks
3 VxWorks This chapter describes the OS specific parts of OTP which relate to VxWorks. 3.1 Introduction The Erlang/OTP distribution for VxWorks is limited to what Switchboard requires (Switchboard is...
Concurrent Programming
3 Concurrent Programming 3.1 Processes One of the main reasons for using Erlang instead of other functional languages is Erlang's ability to handle concurrency and distributed programming. By...
Introduction
1 Introduction 1.1 Introduction This is a "kick start" tutorial to get you started with Erlang. Everything here is true, but only part of the truth. For example, I'll only tell you the simplest form...
Records and Macros
5 Records and Macros Larger programs are usually written as a collection of files with a well defined interface between the various parts. 5.1 The Larger Example Divided into Several Files To...
Robustness
4 Robustness There are several things which are wrong with the messenger example from the previous chapter. For example if a node where a user is logged on goes down without doing a log off, the user...
Sequential Programming
2 Sequential Programming 2.1 The Erlang Shell Most operating systems have a command interpreter or shell, Unix and Linux have many, Windows has the Command Prompt. Erlang has its own shell where you...
Installation
1 Installation 1.1 UNIX 1.1.1 Introduction The system is delivered as a single compressed tar file. To browse the on-line HTML documentation, Netscape or an equivalent browser supporting frames is...
Installation Verification
2 Installation Verification This chapter is about verifying your installation by performing a few simple tests to see that your system is properly installed. 2.1 UNIX Start Erlang/OTP from the...
Introduction
1 Introduction The operation and maintenance support in OTP consists of a generic model for management subsystems in OTP, and some components to be used in these subsystems. This document describes...
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z A Equivalent to application(Application, []). edoc:application/1...
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z B Notify the target object that the transaction has been rolled back...
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z C Rehash or create code path cache code:rehash/0 Calculate CRC...
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z D Connect to an ssh daemon ssh_cm:connect/1 Connect to an ssh daemon...
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z E Return true if the target object and the supplied object easily can...
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z F Return a full inter face description record describing the...
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z G Force an immediate garbage collection of a process...
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z H Halt the Erlang runtime system erlang:halt/1 Halt the...
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z I Searche for modules with identical names. code:clash/0 Return all...
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z J Adds different types of jobs to the run queue....
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z K Sets the number of previous commands to keep shell:history/1 Sets...
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z L Returns the label and value-expression of a record field specifier....
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z M Compute an MD5 MACmessage authentification code crypto:md5_mac/2...
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z N Add a module to the job queue with or without a given name....
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z O Add a new filter to the target object...
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z P Return the PacingInterval QoS identifier...
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z Q Creates an abstract qualified name. erl_syntax:qualified_name/1...
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z R Return a list of exception types that can be raised by the target...
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z S Fix a Dets table for safe traversal. dets:safe_fixtable/2 Fix an...
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z T Delete permanently all replicas of table Tab. mnesia:delete_table/1...
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z U Unblock a disk log. disk_log:unblock/1 Yields a document...
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z V Read the agent vacm config from the config file...
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z W Sends one or more transaction request(s) but does NOT wait for a...
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z X Equivalent to process_validate(Schema, Xml, [])....
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z Y Check if a year is a leap year calendar:is_leap_year/1 Compute the...
Erlang/OTP Permuted Index
Erlang/OTP Permuted Index Permuted index of Erlang/OTP functions and commands A B C D E F G H I J K L M N O P Q R S T U V W X Y Z Z Create a new, extendible array with initial size zero. array:new/0...
Bit Syntax
4 Bit Syntax 4.1 Introduction In Erlang a Bin is used for constructing binaries and matching binary patterns. A Bin is written with the following syntax: <<E1, E2, ... En>> A Bin is a...
Funs
2 Funs 2.1 Example 1 - map If we want to double every element in a list, we could write a function named double : double([H|T]) -> [2*H|double(T)]; double([]) -> []. This function obviously...
List Comprehensions
3 List Comprehensions 3.1 Simple Examples We start with a simple example: > [X || X <- [1,2,a,3,4,b,5,6], X > 3]. [a,4,b,5,6] This should be read as follows: The list of X such that X is...
Records
1 Records 1.1 Records vs Tuples The main advantage of using records instead of tuples is that fields in a record are accessed by name, whereas fields in a tuple are accessed by position. To...
Compilation and Code Loading
12 Compilation and Code Loading How code is compiled and loaded is not a language issue, but is system dependent. This chapter describes compilation and code loading in Erlang/OTP with pointers to...
Data Types
2 Data Types 2.1 Terms Erlang provides a number of data types which are listed in this chapter. A piece of data of any data type is called a term . 2.2 Number There are two types of numeric literals,...
Distributed Erlang
11 Distributed Erlang 11.1 Distributed Erlang System A distributed Erlang system consists of a number of Erlang runtime systems communicating with each other. Each such runtime system is called a...
Errors and Error Handling
9 Errors and Error Handling 9.1 Terminology Errors can roughly be divided into four different types: Compile-time errors Logical errors Run-time errors Generated errors A compile-time error, for...
Expressions
6 Expressions In this chapter, all valid Erlang expressions are listed. When writing Erlang programs, it is also allowed to use macro- and record expressions. However, these expressions are expanded...
The Preprocessor
7 The Preprocessor 7.1 File Inclusion A file can be included in the following way: -include(File). -include_lib(File). File , a string, should point out a file. The contents of this file are included...
Modules
4 Modules 4.1 Module Syntax Erlang code is divided into modules . A module consists of a sequence of attributes and function declarations, each terminated by period (.). Example: -module(m). % module...
Pattern Matching
3 Pattern Matching 3.1 Pattern Matching Variables are bound to values through the pattern matching mechanism. Pattern matching occurs when evaluating a function call, case - receive - try -...
Ports and Port Drivers
13 Ports and Port Drivers Examples of how to use ports and port drivers can be found in Interoperability Tutorial . The BIFs mentioned are as usual documented in erlang(3) . 13.1 Ports Ports provide...
Introduction
1 Introduction 1.1 Erlang and OTP Erlang is a general-purpose programming language with built-in support for concurrency, distribution and fault tolerance. OTP (Open Telecom Platform) is aimed at...
Creating a First Target System
3 Creating a First Target System 3.1 Introduction When creating a system using Erlang/OTP, the most simple way is to install Erlang/OTP somewhere, install the application specific code somewhere...
Error Logging
2 Error Logging 2.1 Error Information From the Runtime System Error information from the runtime system, that is, information about a process terminating due to an uncaught error exception, is by...
System Principles
1 System Principles 1.1 Starting the System An Erlang runtime system is started with the command erl : % erl Erlang (BEAM) emulator version 5.2.3.5 [hipe] [threads:0] Eshell V5.2.3.5 (abort with ^G)...
Ports
4 Ports This is an example of how to solve the example problem by using a port. Port Communication. 4.1 Erlang Program First of all communication between Erlang and C must be established by creating...
Port drivers
6 Port drivers This is an example of how to solve the example problem by using a linked in port driver. Port Driver Communication. 6.1 Port Drivers A port driver is a linked in driver, that is...
C Nodes
7 C Nodes This is an example of how to solve the example problem by using a C node. Note that a C node would not typically be used for solving a simple problem like this, a port would suffice. 7.1...
Erl_Interface
5 Erl_Interface This is an example of how to solve the example problem by using a port and erl_interface . It is necessary to read the port example before reading this chapter. 5.1 Erlang Program The...
Problem Example
3 Problem Example 3.1 Description A common interoperability situation is when there exists a piece of code solving some complex problem, and we would like to incorporate this piece of code in our...
Overview
2 Overview 2.1 Built-In Mechanisms There are two interoperability mechanisms built into the Erlang runtime system. One is distributed Erlang and the other one is ports . A variation of ports is...
The Abstract Format
4 The Abstract Format This document describes the standard representation of parse trees for Erlang programs as Erlang terms. This representation is known as the abstract format . Functions dealing...
How to implement an alternative carrier for the Erlang distribution
3 How to implement an alternative carrier for the Erlang distribution This document describes how one can implement ones own carrier protocol for the Erlang distribution. The distribution is normally...
How to interpret the Erlang crash dumps
2 How to interpret the Erlang crash dumps This document describes the erl_crash.dump file generated upon abnormal exit of the Erlang runtime system. Important: For OTP release R9C the Erlang crash...
How to implement a driver
6 How to implement a driver 6.1 Introduction This chapter tells you how to build your own driver for erlang. A driver in Erlang is a library written in C, that is linked to the Erlang emulator and...
driver_entry
driver_entry MODULE driver_entry MODULE SUMMARY The driver-entry structure used by erlang drivers. DESCRIPTION As of erts version 5.5.3 the driver interface has been extended (see extended marker )....
epmd
epmd COMMAND epmd COMMAND SUMMARY Erlang Port Mapper Daemon DESCRIPTION This daemon acts as a name server on all hosts involved in distributed Erlang computations. When an Erlang node starts, the...
erl
erl COMMAND erl COMMAND SUMMARY The Erlang Emulator DESCRIPTION The erl program starts an Erlang runtime system. The exact details (for example, whether erl is a script or a program and which other...
Distribution Protocol
9 Distribution Protocol The description here is far from complete and will therefore be further refined in upcoming releases. The protocols both from Erlang nodes towards EPMD (Erlang Port Mapper...
erl_driver
erl_driver MODULE erl_driver MODULE SUMMARY API functions for an Erlang driver DESCRIPTION As of erts version 5.5.3 the driver interface has been extended (see extended marker ). The extended...
External Term Format
8 External Term Format 8.1 Introduction The external term format is mainly used in the distribution mechanism of Erlang. Since Erlang has a fixed number of types, there is no need for a programmer to...
erl_set_memory_block
erl_set_memory_block C LIBRARY erl_set_memory_block C LIBRARY SUMMARY Custom memory allocation for Erlang on VxWorks DESCRIPTION This documentation is specific to VxWorks. The erl_set_memory_block...
erlc
erlc COMMAND erlc COMMAND SUMMARY Compiler DESCRIPTION The erlc program provides a common way to run all compilers in the Erlang system. Depending on the extension of each input file, erlc will...
erlsrv
erlsrv COMMAND erlsrv COMMAND SUMMARY Run the Erlang emulator as a service on Windows NT DESCRIPTION This utility is specific to Windows NT/2000/XP It allows Erlang emulators to run as services on...
erts_alloc
erts_alloc C LIBRARY erts_alloc C LIBRARY SUMMARY An Erlang Run-Time System internal memory allocator library. DESCRIPTION erts_alloc is an Erlang Run-Time System internal memory allocator library....
escript
escript COMMAND escript COMMAND SUMMARY Erlang scripting support DESCRIPTION escript provides support for running short Erlang programs without having to compile them first and an easy way to...
ERTS Reference Manual
This documentation requires a browser that can handle frames
Inet configuration
7 Inet configuration 7.1 Introduction This chapter tells you how the Erlang runtime system is configured for IP communication. It also explains how you may configure it for your own particular needs...
Match specifications in Erlang
1 Match specifications in Erlang A "match specification" (match_spec) is an Erlang term describing a small "program" that will try to match something (either the parameters to a function as used in...
ERTS Release Notes
1 ERTS Release Notes This document describes the changes made to the ERTS application. 1.1 Erts 5.6.3 1.1.1 Fixed Bugs and Malfunctions Only one to_erl process at a time is allowed to connect to the...
ERTS Release Notes History
1 ERTS Release Notes History 1.1 ERTS 5.4 1.1.1 Fixed Bugs and Malfunctions The BIF is_record(Record,RecordTag) has been added to the run-time system. It checks that Record is a tuple whose first...
ERTS Release Notes
ERTS User's Guide | ERTS Reference Manual | Release Notes | Off-Print | Top ERTS Release Notes Version 5.6.3 Bibliography | Glossary | Cover Table of Contents 1 ERTS Release Notes 1.1 Erts 5.6.3 1.2...
ERTS Release Notes
ERTS Release Notes Version 5.6.3 The Erlang Runtime System application ERTS . For information about older versions, see Release Notes History . erts 5.6.3 Copyright © 1991-2008 Ericsson AB
ERTS Release Notes
This documentation requires a browser that can handle frames
ERTS Release Notes History
ERTS User's Guide | ERTS Reference Manual | Release Notes | Off-Print | Top ERTS Release Notes History Version 5.6.3 Bibliography | Glossary | Cover Table of Contents 1 ERTS Release Notes History 1.1...
ERTS Release Notes History
This documentation requires a browser that can handle frames
ERTS Reference Manual
ERTS User's Guide | ERTS Reference Manual | Release Notes | Off-Print | Top ERTS Reference Manual Version 5.6.3 Bibliography | Glossary | Index | Cover Table of Contents epmd erl erlc werl escript...
ERTS Reference Manual
ERTS Reference Manual Version 5.6.3 The Erlang Runtime System Application ERTS . Note By default, the erts is only guaranteed to be compatible with other Erlang/OTP components from the same release...
ERTS Reference Manual
This documentation requires a browser that can handle frames
INDEX
INDEX Emphasized index entries refer to modules and Courier ditos to functions . ErlDrvBinary erl_driver ErlDrvBinary* driver_alloc_binary/1 erl_driver ErlDrvBinary* driver_realloc_binary/2...
run_erl
run_erl COMMAND run_erl COMMAND SUMMARY Redirect Erlang input and output streams on Solaris DESCRIPTION This describes the run_erl program specific to Solaris/Linux. This program redirect the...
start
start COMMAND start COMMAND SUMMARY OTP start script example for Unix DESCRIPTION This describes the start script that is an example script on how to startup the Erlang system in embedded mode on...
start_erl
start_erl COMMAND start_erl COMMAND SUMMARY Start Erlang for embedded systems on Windows NT DESCRIPTION This describes the start_erl program specific to Windows NT. Although there exists programs...
tty - A command line interface
5 tty - A command line interface tty is a simple command line interface program where keystrokes are collected and interpreted. Completed lines are sent to the shell for interpretation. There is a...
werl
werl COMMAND werl COMMAND SUMMARY The Erlang Emulator DESCRIPTION On Windows, the preferred way to start the Erlang system for interactive use is: werl <arguments> This will start Erlang in its...
appmon
appmon MODULE appmon MODULE SUMMARY A graphical node and application process tree viewer. DESCRIPTION The application monitor Appmon is a graphical utility used to supervise applications executing...
Appmon
1 Appmon 1.1 Introduction The application monitor Appmon is a graphical node and application viewer. The tool shows an overview of all applications on all known nodes, and it is possible to view the...
Specialized Decodes
2 Specialized Decodes When performance is of highest priority and one is interested in a limited part of the ASN.1 encoded message, before one decide what to do with the rest of it, one may want to...
Asn1
1 Asn1 1.1 Introduction 1.1.1 Features The Asn1 application provides: An ASN.1 compiler for Erlang, which generates encode and decode functions to be used by Erlang programs sending and receiving...
asn1ct
asn1ct MODULE asn1ct MODULE SUMMARY ASN.1 compiler and compile-time support functions DESCRIPTION The ASN.1 compiler takes an ASN.1 module as input and genarates a corresponding Erlang module which...
asn1rt
asn1rt MODULE asn1rt MODULE SUMMARY ASN.1 runtime support functions DESCRIPTION This module is the interface module for the ASN.1 runtime support functions. To encode and decode ASN.1 types in...
Common Test Basics
1 Common Test Basics 1.1 Introduction The Common Test framework (CT) is a tool which can support implementation and automated execution of test cases towards different types of target systems. The...
Common Test
Common Test APPLICATION common_test APPLICATION SUMMARY A framework for automatic testing of a variety of target nodes DESCRIPTION The Common Test framework is an environment for writing and...
Config Files
7 Config Files 7.1 General The Common Test framework uses configuration files to describe data related to a test or a test plant. The configuration data makes it possible to change properties without...
Code Coverage Analysis
8 Code Coverage Analysis 8.1 General Although Common Test was created primarly for the purpose of black box testing, nothing prevents it from working perfectly as a white box testing tool as well....
ct
ct MODULE ct MODULE SUMMARY Main user interface for the Common Test framework. DESCRIPTION Main user interface for the Common Test framework. This module implements the command line interface for...
ct_cover
ct_cover MODULE ct_cover MODULE SUMMARY Common Test Framework code coverage support module. DESCRIPTION Common Test Framework code coverage support module. This module exports help functions for...
ct_ftp
ct_ftp MODULE ct_ftp MODULE SUMMARY Common Test specific layer on top of OTP ftp clinet ftp.erl. DESCRIPTION Common Test specific layer on top of OTP ftp clinet ftp.erl DATA TYPES connection() =...
ct_master
ct_master MODULE ct_master MODULE SUMMARY Distributed test execution control for Common Test. DESCRIPTION Distributed test execution control for Common Test. This module exports functions for running...
Using Common Test for Large Scale Testing
9 Using Common Test for Large Scale Testing 9.1 General Large scale automated testing requires running multiple independent test sessions in parallel. This is accomplished by running a number of...
ct_rpc
ct_rpc MODULE ct_rpc MODULE SUMMARY Common Test specific layer on Erlang/OTP rpc. DESCRIPTION Common Test specific layer on Erlang/OTP rpc. EXPORTS app_node(App, Candidates) -> NodeName Types: App...
ct_snmp
ct_snmp MODULE ct_snmp MODULE SUMMARY Common Test specific layer on top of the OTPs snmp. DESCRIPTION Common Test specific layer on top of the OTPs snmp Application to make snmp configuration easier...
ct_telnet
ct_telnet MODULE ct_telnet MODULE SUMMARY Common Test specific layer on top of telnet client ct_telnet_client.erl. DESCRIPTION Common Test specific layer on top of telnet client ct_telnet_client.erl...
Dependencies between Test Cases and Suites
11 Dependencies between Test Cases and Suites 11.1 General When creating test suites, it is strongly recommended to not create dependencies between test cases, i.e. letting test cases depend on the...
Event Handling
10 Event Handling 10.1 General It is possible for the operator of a Common Test system to receive event notifications continously during a test session execution. It is reported e.g. when a test case...
Examples
5 Examples 5.1 Test suite The example test suite shows some tests of an HTTP client that uses a proxy. -module(httpc_proxy_SUITE). %% Note: This directive should only be used in test suites....
Installation
2 Installation 2.1 Unix Copy the Common Test and Test Server application directories, common_test-<vsn> and test_server-<vsn> , to a location of your choice. They do not have to be placed...
The run_test shell script
The run_test shell script APPLICATION run_test APPLICATION SUMMARY Shell script used for starting Common Test from the Unix command line. DESCRIPTION The run_test script is automatically generated as...
Running Test Suites
6 Running Test Suites 6.1 Using the Common Test Framework The Common Test Framework provides a high level operator interface for testing. It adds the following features to the Erlang/OTP Test Server:...
Test Structure
4 Test Structure 4.1 Test structure A test consists of a set of test cases. Each test case is implemented as an Erlang function. An Erlang module implementing one or more test cases is called a test...
unix_telnet
unix_telnet MODULE unix_telnet MODULE SUMMARY Callback module for ct_telnet for talking telnet to a unix host. DESCRIPTION Callback module for ct_telnet for talking telnet to a unix host. It requires...
Some thoughts about testing
12 Some thoughts about testing 12.1 Goals It's not possible to prove that a program is correct by testing. On the contrary, it has been formally proven that it is impossible to prove programs in...
Writing Test Suites
3 Writing Test Suites 3.1 Support for test suite authors The ct module provides the main interface for writing test cases. This includes: Functions for printing and logging Functions for reading...
compile
compile MODULE compile MODULE SUMMARY Erlang Compiler DESCRIPTION This module provides an interface to the standard Erlang compiler. It can generate either a new file which contains the object code,...
The cosEvent Application
1 The cosEvent Application 1.1 Content Overview The cosEvent documentation is divided into three sections: PART ONE - The User's Guide Description of the cosEvent Application including services and a...
Event Service
3 Event Service 3.1 Overview of the CosEvent Service The Event service allows programmers to subscribe to information channels. Suppliers can generate events without knowing the consumer identities...
Introduction to cosEvent
2 Introduction to cosEvent 2.1 Overview The cosEvent application is a Event Service compliant with the OMG Event Service CosEvent. 2.1.1 Purpose and Dependencies CosEvent is dependent on Orber ,...
cosEventApp
cosEventApp MODULE cosEventApp MODULE SUMMARY The main module of the cosEvent application. DESCRIPTION To get access to the record definitions for the structures use:...
CosEventChannelAdmin
CosEventChannelAdmin MODULE CosEventChannelAdmin MODULE SUMMARY The CosEventChannelAdmin defines a set if event service interfaces that enables decoupled asynchronous communication between objects...
CosEventChannelAdmin_ConsumerAdmin
CosEventChannelAdmin_ConsumerAdmin MODULE CosEventChannelAdmin_ConsumerAdmin MODULE SUMMARY This module implements a ConsumerAdmin interface, which allows consumers to be connected to the event...
CosEventChannelAdmin_EventChannel
CosEventChannelAdmin_EventChannel MODULE CosEventChannelAdmin_EventChannel MODULE SUMMARY This module implements an Event Channel interface, which plays the role of a mediator between consumers and...
CosEventChannelAdmin_ProxyPullConsumer
CosEventChannelAdmin_ProxyPullConsumer MODULE CosEventChannelAdmin_ProxyPullConsumer MODULE SUMMARY This module implements a ProxyPullConsumer interface which acts as a middleman between pull...
CosEventChannelAdmin_ProxyPullSupplier
CosEventChannelAdmin_ProxyPullSupplier MODULE CosEventChannelAdmin_ProxyPullSupplier MODULE SUMMARY This module implements a ProxyPullSupplier interface which acts as a middleman between pull...
CosEventChannelAdmin_ProxyPushConsumer
CosEventChannelAdmin_ProxyPushConsumer MODULE CosEventChannelAdmin_ProxyPushConsumer MODULE SUMMARY This module implements a ProxyPushConsumer interface which acts as a middleman between push...
CosEventChannelAdmin_ProxyPushSupplier
CosEventChannelAdmin_ProxyPushSupplier MODULE CosEventChannelAdmin_ProxyPushSupplier MODULE SUMMARY This module implements a ProxyPushSupplier interface which acts as a middleman between push...
CosEventChannelAdmin_SupplierAdmin
CosEventChannelAdmin_SupplierAdmin MODULE CosEventChannelAdmin_SupplierAdmin MODULE SUMMARY This module implements a SupplierAdmin interface, which allows suppliers to be connected to the event...
Event Domain Service
4 Event Domain Service 4.1 Overview of the CosEventDomain Service The Event Domain service allows programmers to manage a cluster of information channels. 4.1.1 Event Domain Service Components There...
Quality Of Service and Admin Properties
3 Quality Of Service and Admin Properties 3.1 Quality Of Service and Admin Properties This chapter explains the allowed properties it is possible to set for this application. 3.1.1 Quality Of Service...
CosEventDomainAdmin
CosEventDomainAdmin MODULE CosEventDomainAdmin MODULE SUMMARY This module export functions which return QoS and Admin Properties constants. DESCRIPTION To get access to all definitions include...
CosEventDomainAdmin_EventDomain
CosEventDomainAdmin_EventDomain MODULE CosEventDomainAdmin_EventDomain MODULE SUMMARY This module implements the Event Domain interface. DESCRIPTION To get access to all definitions include necessary...
CosEventDomainAdmin_EventDomainFactory
CosEventDomainAdmin_EventDomainFactory MODULE CosEventDomainAdmin_EventDomainFactory MODULE SUMMARY This module implements an Event Domain Factory interface, which is used to create new Event Domain...
cosEventDomainApp
cosEventDomainApp MODULE cosEventDomainApp MODULE SUMMARY The main module of the cosEventDomain application. DESCRIPTION To get access to the record definitions for the structures use:...
cosFileTransfer Examples
5 cosFileTransfer Examples 5.1 A tutorial on how to create a simple service 5.1.1 Initiate the application To use the complete cosFileTransfer application cosProperty must be installed. 5.1.2 How to...
Installing cosFileTransfer
3 Installing cosFileTransfer 3.1 Installation Process This chapter describes how to install cosFileTransferApp in an Erlang Environment. 3.1.1 Preparation Before starting the installation process for...
Using the File Transfer Service
4 Using the File Transfer Service 4.1 Overview This chapter describes how two File Transfer Service applications interact. 4.1.1 Components There are several ways the OMG File Transfer Service can be...
CosFileTransfer_Directory
CosFileTransfer_Directory MODULE CosFileTransfer_Directory MODULE SUMMARY This module implements the OMG CosFileTransfer::Directory interface. DESCRIPTION To get access to the record definitions for...
CosFileTransfer_File
CosFileTransfer_File MODULE CosFileTransfer_File MODULE SUMMARY This module implements the OMG CosFileTransfer::File interface. DESCRIPTION To get access to the record definitions for the structures...
CosFileTransfer_FileIterator
CosFileTransfer_FileIterator MODULE CosFileTransfer_FileIterator MODULE SUMMARY This module implements the OMG CosFileTransfer::FileIterator interface. DESCRIPTION To get access to the record...
CosFileTransfer_FileTransferSession
CosFileTransfer_FileTransferSession MODULE CosFileTransfer_FileTransferSession MODULE SUMMARY This module implements the OMG CosFileTransfer::FileTransferSession interface. DESCRIPTION To get access...
CosFileTransfer_VirtualFileSystem
CosFileTransfer_VirtualFileSystem MODULE CosFileTransfer_VirtualFileSystem MODULE SUMMARY This module implements the OMG CosFileTransfer::VirtualFileSystem interface. DESCRIPTION To get access to the...
cosFileTransferApp
cosFileTransferApp MODULE cosFileTransferApp MODULE SUMMARY The main module of the cosFileTransfer application. DESCRIPTION To get access to the record definitions for the structures use:...
Filters and the Constraint Language BNF
5 Filters and the Constraint Language BNF 5.1 Filters and the Constraint Language BNF This chapter describes, the grammar supported by CosNotifyFilter_Filter and CosNotifyFilter_MappingFilter , and...
CosNotification
CosNotification MODULE CosNotification MODULE SUMMARY This module export functions which return QoS and Admin Properties constants. DESCRIPTION To get access to all definitions include necessary hrl...
CosNotification_AdminPropertiesAdmin
CosNotification_AdminPropertiesAdmin MODULE CosNotification_AdminPropertiesAdmin MODULE SUMMARY This module implements the OMG CosNotification::AdminPropertiesAdmin interface. DESCRIPTION To get...
CosNotification_QoSAdmin
CosNotification_QoSAdmin MODULE CosNotification_QoSAdmin MODULE SUMMARY This module implements the OMG CosNotification::QoSAdmin interface. DESCRIPTION To get access to the record definitions for the...
cosNotificationApp
cosNotificationApp MODULE cosNotificationApp MODULE SUMMARY The main module of the cosNotification application. DESCRIPTION To get access to the record definitions for the structures use:...
CosNotifyChannelAdmin_ConsumerAdmin
CosNotifyChannelAdmin_ConsumerAdmin MODULE CosNotifyChannelAdmin_ConsumerAdmin MODULE SUMMARY This module implements the OMG CosNotifyChannelAdmin::ConsumerAdmin interface. DESCRIPTION To get access...
CosNotifyChannelAdmin_EventChannel
CosNotifyChannelAdmin_EventChannel MODULE CosNotifyChannelAdmin_EventChannel MODULE SUMMARY This module implements the OMG CosNotifyChannelAdmin::EventChannel interface. DESCRIPTION To get access to...
CosNotifyChannelAdmin_EventChannelFactory
CosNotifyChannelAdmin_EventChannelFactory MODULE CosNotifyChannelAdmin_EventChannelFactory MODULE SUMMARY This module implements the OMG CosNotifyChannelAdmin::EventChannelFactory interface....
CosNotifyChannelAdmin_ProxyConsumer
CosNotifyChannelAdmin_ProxyConsumer MODULE CosNotifyChannelAdmin_ProxyConsumer MODULE SUMMARY This module implements the OMG CosNotifyChannelAdmin::ProxyConsumer interface. DESCRIPTION To get access...
CosNotifyChannelAdmin_ProxyPullConsumer
CosNotifyChannelAdmin_ProxyPullConsumer MODULE CosNotifyChannelAdmin_ProxyPullConsumer MODULE SUMMARY This module implements the OMG CosNotifyChannelAdmin::ProxyPullConsumer interface. DESCRIPTION To...
CosNotifyChannelAdmin_ProxyPullSupplier
CosNotifyChannelAdmin_ProxyPullSupplier MODULE CosNotifyChannelAdmin_ProxyPullSupplier MODULE SUMMARY This module implements the OMG CosNotifyChannelAdmin::ProxyPullSupplier interface. DESCRIPTION To...
CosNotifyChannelAdmin_ProxyPushConsumer
CosNotifyChannelAdmin_ProxyPushConsumer MODULE CosNotifyChannelAdmin_ProxyPushConsumer MODULE SUMMARY This module implements the OMG CosNotifyChannelAdmin::ProxyPushConsumer interface. DESCRIPTION To...
CosNotifyChannelAdmin_ProxyPushSupplier
CosNotifyChannelAdmin_ProxyPushSupplier MODULE CosNotifyChannelAdmin_ProxyPushSupplier MODULE SUMMARY This module implements the OMG CosNotifyChannelAdmin::ProxyPushSupplier interface. DESCRIPTION To...
CosNotifyChannelAdmin_ProxySupplier
CosNotifyChannelAdmin_ProxySupplier MODULE CosNotifyChannelAdmin_ProxySupplier MODULE SUMMARY This module implements the OMG CosNotifyChannelAdmin::ProxySupplier interface. DESCRIPTION To get access...
CosNotifyChannelAdmin_SequenceProxyPullConsumer
CosNotifyChannelAdmin_SequenceProxyPullConsumer MODULE CosNotifyChannelAdmin_SequenceProxyPullConsumer MODULE SUMMARY This module implements the OMG CosNotifyChannelAdmin::SequenceProxyPullConsumer...
CosNotifyChannelAdmin_SequenceProxyPullSupplier
CosNotifyChannelAdmin_SequenceProxyPullSupplier MODULE CosNotifyChannelAdmin_SequenceProxyPullSupplier MODULE SUMMARY This module implements the OMG CosNotifyChannelAdmin::SequenceProxyPullSupplier...
CosNotifyChannelAdmin_SequenceProxyPushConsumer
CosNotifyChannelAdmin_SequenceProxyPushConsumer MODULE CosNotifyChannelAdmin_SequenceProxyPushConsumer MODULE SUMMARY This module implements the OMG CosNotifyChannelAdmin::SequenceProxyPushConsumer...
CosNotifyChannelAdmin_SequenceProxyPushSupplier
CosNotifyChannelAdmin_SequenceProxyPushSupplier MODULE CosNotifyChannelAdmin_SequenceProxyPushSupplier MODULE SUMMARY This module implements the OMG CosNotifyChannelAdmin::SequenceProxyPushSupplier...
CosNotifyChannelAdmin_StructuredProxyPullConsumer
CosNotifyChannelAdmin_StructuredProxyPullConsumer MODULE CosNotifyChannelAdmin_StructuredProxyPullConsumer MODULE SUMMARY This module implements the OMG...
CosNotifyChannelAdmin_StructuredProxyPullSupplier
CosNotifyChannelAdmin_StructuredProxyPullSupplier MODULE CosNotifyChannelAdmin_StructuredProxyPullSupplier MODULE SUMMARY This module implements the OMG...
CosNotifyChannelAdmin_StructuredProxyPushConsumer
CosNotifyChannelAdmin_StructuredProxyPushConsumer MODULE CosNotifyChannelAdmin_StructuredProxyPushConsumer MODULE SUMMARY This module implements the OMG...
CosNotifyChannelAdmin_StructuredProxyPushSupplier
CosNotifyChannelAdmin_StructuredProxyPushSupplier MODULE CosNotifyChannelAdmin_StructuredProxyPushSupplier MODULE SUMMARY This module implements the OMG...
CosNotifyChannelAdmin_SupplierAdmin
CosNotifyChannelAdmin_SupplierAdmin MODULE CosNotifyChannelAdmin_SupplierAdmin MODULE SUMMARY This module implements the OMG CosNotifyChannelAdmin::SupplierAdmin interface. DESCRIPTION To get access...
CosNotifyComm_NotifyPublish
CosNotifyComm_NotifyPublish MODULE CosNotifyComm_NotifyPublish MODULE SUMMARY This module implements the OMG CosNotifyComm::NotifyPublish interface. DESCRIPTION To get access to the record...
CosNotifyComm_NotifySubscribe
CosNotifyComm_NotifySubscribe MODULE CosNotifyComm_NotifySubscribe MODULE SUMMARY This module implements the OMG CosNotifyComm::NotifySubscribe interface. DESCRIPTION To get access to the record...
CosNotifyFilter_Filter
CosNotifyFilter_Filter MODULE CosNotifyFilter_Filter MODULE SUMMARY This module implements the OMG CosNotifyFilter::Filter interface. DESCRIPTION To get access to the record definitions for the...
CosNotifyFilter_FilterAdmin
CosNotifyFilter_FilterAdmin MODULE CosNotifyFilter_FilterAdmin MODULE SUMMARY This module implements the OMG CosNotifyFilter::FilterAdmin interface. DESCRIPTION To get access to the record...
CosNotifyFilter_FilterFactory
CosNotifyFilter_FilterFactory MODULE CosNotifyFilter_FilterFactory MODULE SUMMARY This module implements the OMG CosNotifyFilter::FilterFactory interface. DESCRIPTION To get access to the record...
CosNotifyFilter_MappingFilter
CosNotifyFilter_MappingFilter MODULE CosNotifyFilter_MappingFilter MODULE SUMMARY This module implements the OMG CosNotifyFilter::MappingFilter interface. DESCRIPTION The main purpose of this module...
cosProperty
cosProperty MODULE cosProperty MODULE SUMMARY The main module of the cosProperty application DESCRIPTION To get access to the record definitions for the structures use:...
CosPropertyService_PropertiesIterator
CosPropertyService_PropertiesIterator MODULE CosPropertyService_PropertiesIterator MODULE SUMMARY This module implements the OMG CosPropertyService::PropertiesIterator interface. DESCRIPTION To get...
CosPropertyService_PropertyNamesIterator
CosPropertyService_PropertyNamesIterator MODULE CosPropertyService_PropertyNamesIterator MODULE SUMMARY This module implements the OMG CosPropertyService::PropertyNamesIterator interface. DESCRIPTION...
CosPropertyService_PropertySet
CosPropertyService_PropertySet MODULE CosPropertyService_PropertySet MODULE SUMMARY This module implements the OMG CosPropertyService::PropertySet interface. DESCRIPTION To get access to the record...
CosPropertyService_PropertySetDef
CosPropertyService_PropertySetDef MODULE CosPropertyService_PropertySetDef MODULE SUMMARY This module implements the OMG CosPropertyService::PropertySetDef interface. DESCRIPTION To get access to the...
CosPropertyService_PropertySetDefFactory
CosPropertyService_PropertySetDefFactory MODULE CosPropertyService_PropertySetDefFactory MODULE SUMMARY This module implements the OMG CosPropertyService::PropertySetDefFactory interface. DESCRIPTION...
CosPropertyService_PropertySetFactory
CosPropertyService_PropertySetFactory MODULE CosPropertyService_PropertySetFactory MODULE SUMMARY This module implements the OMG CosPropertyService::PropertySetFactory interface. DESCRIPTION To get...
cosTime
cosTime MODULE cosTime MODULE SUMMARY The main module of the cosTime application DESCRIPTION To get access to the record definitions for the structures use: -include_lib("cosTime/include/*.hrl")....
CosTime_TimeService
CosTime_TimeService MODULE CosTime_TimeService MODULE SUMMARY This module implements the OMG CosTime::TimeService interface. DESCRIPTION To get access to the record definitions for the structures...
CosTime_TIO
CosTime_TIO MODULE CosTime_TIO MODULE SUMMARY This module implements the OMG CosTime::TIO interface. DESCRIPTION To get access to the record definitions for the structures use:...
CosTime_UTO
CosTime_UTO MODULE CosTime_UTO MODULE SUMMARY This module implements the OMG CosTime::UTO interface. DESCRIPTION To get access to the record definitions for the structures use:...
CosTimerEvent_TimerEventHandler
CosTimerEvent_TimerEventHandler MODULE CosTimerEvent_TimerEventHandler MODULE SUMMARY This module implements the OMG CosTimerEvent::TimerEventHandler interface. DESCRIPTION To get access to the...
CosTimerEvent_TimerEventService
CosTimerEvent_TimerEventService MODULE CosTimerEvent_TimerEventService MODULE SUMMARY This module implements the OMG CosTimerEvent::TimerEventService interface. DESCRIPTION To get access to the...
Resource Skeletons
5 Resource Skeletons 5.1 Resource Skeletons This chapter provides a skeleton for application Resources. For more information see the Orber documentation....
cosTransactions
cosTransactions MODULE cosTransactions MODULE SUMMARY The main module of the cosTransactions application. DESCRIPTION To get access to the record definitions for the structures use:...
CosTransactions_Control
CosTransactions_Control MODULE CosTransactions_Control MODULE SUMMARY This module implements the OMG CosTransactions::Control interface. DESCRIPTION To get access to the record definitions for the...
CosTransactions_Coordinator
CosTransactions_Coordinator MODULE CosTransactions_Coordinator MODULE SUMMARY This module implements the OMG CosTransactions::Coordinator interface. DESCRIPTION To get access to the record...
CosTransactions_RecoveryCoordinator
CosTransactions_RecoveryCoordinator MODULE CosTransactions_RecoveryCoordinator MODULE SUMMARY This module implements the OMG CosTransactions::RecoveryCoordinator interface. DESCRIPTION To get access...
CosTransactions_Resource
CosTransactions_Resource MODULE CosTransactions_Resource MODULE SUMMARY This module implements the OMG CosTransactions::Resource interface. DESCRIPTION To get access to the record definitions for the...
CosTransactions_SubtransactionAwareResource
CosTransactions_SubtransactionAwareResource MODULE CosTransactions_SubtransactionAwareResource MODULE SUMMARY This module implements the OMG CosTransactions::SubtransactionAwareResource interface....
CosTransactions_Terminator
CosTransactions_Terminator MODULE CosTransactions_Terminator MODULE SUMMARY This module implements the OMG CosTransactions::Terminator interface. DESCRIPTION To get access to the record definitions...
CosTransactions_TransactionFactory
CosTransactions_TransactionFactory MODULE CosTransactions_TransactionFactory MODULE SUMMARY This module implements the OMG CosTransactions::TransactionFactory interface. DESCRIPTION To get access to...
crypto
crypto MODULE crypto MODULE SUMMARY Crypto Functions DESCRIPTION This module provides a set of cryptographic functions. References: md5: The MD5 Message Digest Algorithm (RFC 1321) sha: Secure Hash...
crypto
crypto APPLICATION crypto APPLICATION SUMMARY The Crypto Application DESCRIPTION The purpose of the Crypto application is to provide message digest and DES encryption for SMNPv3. It provides...
Licenses
1 Licenses This chapter contains in extenso versions of the OpenSSL and SSLeay licenses. 1.1 OpenSSL License /* ==================================================================== * Copyright (c)...
Crypto Release Notes
User's Guide | Reference Manual | Release Notes | Off-Print | Top Crypto Release Notes Version 1.5.2 Bibliography | Glossary | Cover Table of Contents 1 Crypto Release Notes 1.1 Crypto 1.5.2 1.2...
Crypto Release Notes
Crypto Release Notes Version 1.5.2 The Crypto Application provides functions for computation of message digests, and encryption and decryption functions. This product includes software developed by...
Crypto Release Notes
This documentation requires a browser that can handle frames
Crypto User's Guide
User's Guide | Reference Manual | Release Notes | Off-Print | Top Crypto User's Guide Version 1.5.2 Bibliography | Glossary | Cover Table of Contents 1 Licenses 1.1 OpenSSL License 1.2 SSLeay License
Crypto User's Guide
Crypto User's Guide Version 1.5.2 The Crypto application provides functions for computation of message digests, and functions for encryption and decryption. This product includes software developed...
Crypto User's Guide
This documentation requires a browser that can handle frames
debugger
debugger MODULE debugger MODULE SUMMARY Erlang Debugger DESCRIPTION Erlang Debugger for debugging and testing of Erlang programs. EXPORTS start() start(File) start(Mode) start(Mode, File) Types: Mode...
Debugger
1 Debugger 1.1 Introduction Debugger is a graphical user interface for the Erlang interpreter, which can be used for debugging and testing of Erlang programs. For example, breakpoints can be set,...
i
i MODULE i MODULE SUMMARY Debugger/Interpreter Interface DESCRIPTION The module i provides short forms for some of the functions used by the graphical Debugger and some of the functions in the int...
int
int MODULE int MODULE SUMMARY Interpreter Interface DESCRIPTION The Erlang interpreter provides mechanisms for breakpoints and stepwise execution of code. It is mainly intended to be used by the...
dialyzer
dialyzer MODULE dialyzer MODULE SUMMARY The Dialyzer, a DIscrepancy AnalYZer for ERlang programs DESCRIPTION The Dialyzer is a static analysis tool that identifies software discrepancies such as type...
Dialyzer
1 Dialyzer 1.1 Introduction Dialyzer is a static analysis tool that identifies software discrepancies such as type errors, unreachable code, unnecessary tests, etc in single Erlang modules or entire...
Block Tags
6 Block Tags Block tags typically define a separate block of information, such as a paragraph or a list. The following subset of block tags are common for all DTDs in the DocBuilder DTD suite:...
Character Entities
8 Character Entities 8.1 Added Latin 1 The DocBuilder DTD suite uses the same character entities as defined in HTML 3.2 ( ISO 8879-1986//ENTITIES Added Latin 1//EN//HTML ). That is: for an &...
docb_gen
docb_gen MODULE docb_gen MODULE SUMMARY Generate XML from EDoc comments in Erlang source code. DESCRIPTION docb_gen contains functions for generating XML documentation source code according to the...
docb_transform
docb_transform MODULE docb_transform MODULE SUMMARY Transform XML to HTML DESCRIPTION docb_transform contains functions for transforming XML documentation source code to HTML. EXPORTS file(File)...
docb_xml_check
docb_xml_check MODULE docb_xml_check MODULE SUMMARY Validate XML documentation source code DESCRIPTION docb_xml_check contains functions for validating XML documentation source code. EXPORTS...
docbuilder
docbuilder APPLICATION docbuilder APPLICATION SUMMARY The DocBuilder Application DESCRIPTION DocBuilder provides functionality for generating HTML documentation for Erlang modules and Erlang/OTP...
Fascicules DTDs
4 Fascicules DTDs 4.1 The fascicules DTD The fascicules DTD is a special kind of DTD which can be used to specify the different parts of the documentation, and which one of those should be shown as...
Header Tags
5 Header Tags Each document begins with a header part, which looks the same for all DTDs. Here the title of the document is specified, as well as administrative data like who is responsible for the...
Inline Tags
7 Inline Tags Inline tags are typically used within block tags, for example to highlight a word within a paragraph. 7.1 <br> - Line Break Forces a newline. The <br> tag is both a block-...
Reference Manual DTDs
3 Reference Manual DTDs There are five DTDs for writing manual pages about applications, shell commands, C libraries, Erlang modules and files, all with a similar structure: A header. Name of the...
User's Guide DTDs
2 User's Guide DTDs 2.1 The part DTD The part DTD is intended for a "normal" document, like the User's Guide or Release Notes. First are some paragraphs introducing the main contents. After that...
Welcome to EDoc
1 Welcome to EDoc EDoc is the Erlang program documentation generator. Inspired by the Javadoc(TM) tool for the Java(TM) programming language, EDoc is adapted to the conventions of the Erlang world,...
edoc
edoc MODULE edoc MODULE SUMMARY EDoc - the Erlang program documentation generator. DESCRIPTION EDoc - the Erlang program documentation generator. This module provides the main user interface to EDoc....
edoc_doclet
edoc_doclet MODULE edoc_doclet MODULE SUMMARY Standard doclet module for EDoc. DESCRIPTION Standard doclet module for EDoc. DATA TYPES doclet_gen() = #doclet_gen{sources=[string()], app=no_app() |...
edoc_extract
edoc_extract MODULE edoc_extract MODULE SUMMARY EDoc documentation extraction. DESCRIPTION EDoc documentation extraction. DATA TYPES edoc_env() = edoc_env() (see module edoc_lib) filename() =...
edoc_layout
edoc_layout MODULE edoc_layout MODULE SUMMARY The standard HTML layout module for EDoc. DESCRIPTION The standard HTML layout module for EDoc. See the edoc module for details on usage. EXPORTS...
edoc_lib
edoc_lib MODULE edoc_lib MODULE SUMMARY Utility functions for EDoc. DESCRIPTION Utility functions for EDoc. DATA TYPES edoc_env() Environment information needed by EDoc for generating references. The...
edoc_run
edoc_run MODULE edoc_run MODULE SUMMARY Interface for calling EDoc from Erlang startup options. DESCRIPTION Interface for calling EDoc from Erlang startup options. The following is an example of...
ei
ei C LIBRARY ei C LIBRARY SUMMARY routines for handling the erlang binary term format DESCRIPTION The library ei contains macros and functions to encode and decode the erlang binary term format. With...
ei_connect
ei_connect C LIBRARY ei_connect C LIBRARY SUMMARY Communicate with distributed erlang DESCRIPTION This module enables C programs to communicate with erlang nodes, using the erlang distribution over...
The El Library User's Guide
1 The El Library User's Guide The Erl_Interface library contains functions. which help you integrate programs written in C and Erlang. The functions in Erl_Interface support the following:...
erl_call
erl_call COMMAND erl_call COMMAND SUMMARY Call/Start a Distributed Erlang Node DESCRIPTION erl_call makes it possible to start and/or communicate with a distributed Erlang node. It is built upon the...
erl_connect
erl_connect C LIBRARY erl_connect C LIBRARY SUMMARY Communicate with Distributed Erlang DESCRIPTION This module provides support for communication between distributed Erlang nodes and C nodes, in a...
erl_error
erl_error C LIBRARY erl_error C LIBRARY SUMMARY Error Print Routines DESCRIPTION This module contains some error printing routines taken from Advanced Programming in the UNIX Environment by W....
erl_eterm
erl_eterm C LIBRARY erl_eterm C LIBRARY SUMMARY Functions for Erlang Term Construction DESCRIPTION This module contains functions for creating and manipulating Erlang terms. An Erlang term is...
erl_format
erl_format C LIBRARY erl_format C LIBRARY SUMMARY Create and Match Erlang Terms DESCRIPTION This module contains two routines - one general function for creating Erlang terms and one for pattern...
erl_global
erl_global C LIBRARY erl_global C LIBRARY SUMMARY Access globally registered names DESCRIPTION This module provides support for registering, looking up and unregistering names in the Erlang Global...
erl_malloc
erl_malloc C LIBRARY erl_malloc C LIBRARY SUMMARY Memory Allocation Functions DESCRIPTION This module provides functions for allocating and deallocating memory. EXPORTS ETERM * erl_alloc_eterm(etype)...
erl_marshal
erl_marshal C LIBRARY erl_marshal C LIBRARY SUMMARY Encoding and Decoding of Erlang terms DESCRIPTION This module contains functions for encoding Erlang terms into a sequence of bytes, and for...
EI User's Guide
EI User's Guide | EI Library Reference | Erl_interface Library Reference | Command Reference | Release Notes | Off-Print | Top EI User's Guide Version 3.5.7 Bibliography | Glossary | Cover Table of...
EI User's Guide
This documentation requires a browser that can handle frames
EI Library Reference
EI User's Guide | EI Library Reference | Erl_interface Library Reference | Command Reference | Release Notes | Off-Print | Top EI Library Reference Version 3.5.7 Bibliography | Glossary | Index |...
EI Library Reference
EI Library Reference Version 3.5.7 The ei library is a C interface library for communication with Erlang . Note By default, the ei library is only guaranteed to be compatible with other Erlang/OTP...
EI Library Reference
This documentation requires a browser that can handle frames
INDEX
INDEX Emphasized index entries refer to modules and Courier ditos to functions .
Erl_Interface Library Reference
EI User's Guide | EI Library Reference | Erl_interface Library Reference | Command Reference | Release Notes | Off-Print | Top Erl_Interface Library Reference Version 3.5.7 Bibliography | Glossary |...
Erl_Interface Library Reference
Erl_Interface Library Reference Version 3.5.7 The erl_interface library is a C interface library for communication with Erlang . Note By default, the erl_interface library is only guaranteed to be...
Erl_Interface Library Reference
This documentation requires a browser that can handle frames
INDEX
INDEX Emphasized index entries refer to modules and Courier ditos to functions .
registry
registry C LIBRARY Registry C LIBRARY SUMMARY Store and backup key-value pairs DESCRIPTION This module provides support for storing key-value pairs in a table known as a registry, backing up...
et
et MODULE et MODULE SUMMARY Main API of the Event Trace (ET) application DESCRIPTION Interface module for the Event Trace (ET) application EXPORTS report_event(DetailLevel, FromTo, Label, Contents)...
Usage
2 Usage 2.1 Overview The two major components of the Event Tracer (ET) tool is a graphical sequence chart viewer ( et_viewer ) and its backing storage ( et_collector ). One collector may be used as...
et_collector
et_collector MODULE et_collector MODULE SUMMARY Collect trace events and provide a backing storage appropriate for iteration DESCRIPTION Interface module for the Event Trace (ET) application EXPORTS...
Examples
3 Examples 3.1 A simulated Mnesia transaction The Erlang code for running the simulated Mnesia transaction example in the previous chapter is included in the et/examples/et_demo.erl file: sim_trans()...
Introduction
1 Introduction The Event Tracer (ET) uses the built-in trace mechanism in Erlang and provides tools for collection and graphical viewing of trace data. The viewed trace data is normally collected...
et_selector
et_selector MODULE et_selector MODULE SUMMARY Define event transforms and trace patterns DESCRIPTION EXPORTS make_pattern(RawPattern) -> TracePattern Types: RawPattern = detail_level()...
et_viewer
et_viewer MODULE et_viewer MODULE SUMMARY Displays a sequence chart for trace events (messages/actions) DESCRIPTION EXPORTS file(FileName) -> {ok, ViewerPid} | {error, Reason} Types: FileName() =...
gs
gs MODULE gs MODULE SUMMARY The Graphics System for Erlang. DESCRIPTION The Graphics System, GS, is easy to learn and designed to be portable to many different platforms. In the description below,...
GS - The Graphics System
1 GS - The Graphics System 1.1 Introduction This section describes the general graphics interface to Erlang. This system was designed with the following requirements in mind: a graphics system which...
Interface Functions
2 Interface Functions 2.1 Overview The following interface functions are included with the graphics system: gs:start(). This function starts the graphics server and returns its object identifier. If...
Options
3 Options 3.1 The Option Concept Each object has a set of options. The options are key-value tuples and the key is an atom. Depending on the option, the value can be any Erlang term. Typical options...
Events
4 Events 4.1 Event Messages Events are messages which are sent to the owner process of the object when the user interacts with the object in some way. A simple case is the user pressing a button. An...
Fonts
5 Fonts 5.1 The Font Model Text related objects can be handled with the font option {font,Font} . A Font is represented as a two or three tuple: {Family,Size} {Family,Style,Size} Examples of fonts...
Default Values
6 Default Values 6.1 The Default Value Model When a new object is created, a set of options is provided by the application. Options which are not explicitly given are taken care of by the parent (the...
The Packer
7 The Packer 7.1 The Packer This section describes the geometry manager in GS. When the user resizes a window, the application normally has to resize and move the graphical objects in the window to...
Built-In Objects
8 Built-In Objects 8.1 Overview This section describes the built-in objects of the graphics interface. The following objects exist: Window An ordinary window. Button A simple press button....
OMG IDL
2 OMG IDL 2.1 OMG IDL - Overview The purpose of OMG IDL, Interface Definition Language , mapping is to act as translator between platforms and languages. An IDL specification is supposed to describe...
The C Client Back-end
7 The C Client Back-end 7.1 Introduction With the option {be, c_client} the IDL Compiler generates C client stubs according to the IDL to C mapping, on top of the Erlang distribution and gen_server...
CORBA_Environment C Structure
9 CORBA_Environment C Structure This chapter describes the CORBA_Environment C structure. 9.1 C Structure Here is the complete definition of the CORBA_Environment C structure, defined in file "ic.h"...
IDL to C mapping
6 IDL to C mapping 6.1 Introduction The IC C mapping (used by the C client and C server back-ends) follows the OMG C Language Mapping Specification . The C mapping supports the following: All OMG IDL...
The C Server Back-end
8 The C Server Back-end 8.1 Introduction With the option {be, c_server} the IDL Compiler generates C server skeletons according to the IDL to C mapping, on top of the Erlang distribution and...
Using the Erlang Generic Server Back-end
5 Using the Erlang Generic Server Back-end 5.1 Introduction The mapping of OMG IDL to the Erlang programming language when Erlang generic server is the back-end of choice is similar to the one used...
Using the Plain Erlang Back-end
4 Using the Plain Erlang Back-end 4.1 Introduction The mapping of OMG IDL to the Erlang programming language when Plain Erlang is the back-end of choice is similar to the one used in pure Erlang IDL...
IC Protocol
3 IC Protocol The purpose of this chapter is to explain the bits and bytes of the IC protocol, which is a composition of the Erlang distribution protocol and the Erlang/OTP gen_server protocol. If...
IDL to Java language Mapping
10 IDL to Java language Mapping 10.1 Introduction This chapter describes the mapping of OMG IDL constructs to the Java programming language for the generation of native Java - Erlang communication....
ic
ic MODULE ic MODULE SUMMARY The Erlang IDL Compiler DESCRIPTION The ic module is an Erlang implementation of an OMG IDL compiler. Depending on the choice of back-end the code will map to Erlang, C,...
IC C Protocol Functions
IC C Protocol Functions C LIBRARY ic_c_protocol C LIBRARY SUMMARY IC C Protocol Functions DESCRIPTION This manual page lists some of the functions of the IC C runtime library that are used internally...
IC C Library Functions
IC C Library Functions C LIBRARY ic_clib C LIBRARY SUMMARY IC C Library Functions DESCRIPTION This manual page lists some of the functions in the IC C runtime library. Allocation and Deallocation...
ftp
ftp MODULE ftp MODULE SUMMARY A File Transfer Protocol client DESCRIPTION The ftp module implements a client for file transfer according to a subset of the File Transfer Protocol (see RFC 959)....
FTP Client
2 FTP Client 2.1 Introduction Ftp clients are consider to be rather temporary and are for that reason only started and stopped during runtime and can not be started at application startup. Due to the...
http
http MODULE http MODULE SUMMARY An HTTP/1.1 client DESCRIPTION This module provides the API to a HTTP/1.1 client according to RFC 2616, caching is currentyl not supported. Note When starting the...
HTTP Client
3 HTTP Client 3.1 Introduction The HTTP client default profile will be started when the inets application is started and is then available to all processes on that erlang node. Other profiles may...
HTTP server
4 HTTP server 4.1 Introduction The HTTP server, also referred to as httpd, handles HTTP requests as described in RFC 2616 with a few exceptions such as gateway and proxy functionality. The server...
httpd
httpd MODULE httpd MODULE SUMMARY An implementation of an HTTP 1.1 compliant Web server, as defined in RFC 2616. DESCRIPTION Documents the HTTP server start options, some administrative functions and...
httpd_conf
httpd_conf MODULE httpd_conf MODULE SUMMARY Configuration utility functions to be used by the Erlang Web server API programmer. DESCRIPTION This module provides the Erlang Webserver API programmer...
httpd_socket
httpd_socket MODULE httpd_socket MODULE SUMMARY Communication utility functions to be used by the Erlang Web server API programmer. DESCRIPTION This module provides the Erlang Web server API module...
httpd_util
httpd_util MODULE httpd_util MODULE SUMMARY Miscellaneous utility functions to be used when implementing Erlang Web server API modules. DESCRIPTION This module provides the Erlang Web Server API...
inets
inets MODULE inets MODULE SUMMARY The inets services API DESCRIPTION This module provides the most basic API to the clients and servers, that are part of the Inets application, such as start and...
Introduction
1 Introduction 1.1 Purpose Inets is a container for Internet clients and servers. Currently, an HTTP client and server, a TFPT client and server, and a FTP client has been incorporated into Inets....
mod_alias
mod_alias MODULE mod_alias MODULE SUMMARY URL ailasing. DESCRIPTION Erlang Webserver Server internal API for handling of things such as interaction data exported by the mod_alias module. EXPORTS...
mod_auth
mod_auth MODULE mod_auth MODULE SUMMARY User authentication using text files, dets or mnesia database. DESCRIPTION This module provides for basic user authentication using textual files, dets...
mod_esi
mod_esi MODULE mod_esi MODULE SUMMARY Erlang Server Interface DESCRIPTION This module defines the API - Erlang Server Interface (ESI). Which is a more efficient way of writing erlang scripts for your...
mod_security
mod_security MODULE mod_security MODULE SUMMARY Security Audit and Trailing Functionality DESCRIPTION Security Audit and Trailing Functionality EXPORTS list_auth_users(Port) -> Users | []...
tftp
tftp MODULE tftp MODULE SUMMARY Trivial FTP DESCRIPTION This is a complete implementation of the following IETF standards: RFC 1350, The TFTP Protocol (revision 2). RFC 2347, TFTP Option Extension....
inviso
inviso MODULE inviso MODULE SUMMARY Main API Module to the Inviso Tracer DESCRIPTION With the inviso API runtime components can be started and tracing managed across a network of distributed Erlang...
inviso_as_lib
inviso_as_lib MODULE inviso_as_lib MODULE SUMMARY The Inviso Autostart Utility Library DESCRIPTION The purpose of the Inviso autostart utility library is to facilitate the creation and modification...
Inviso
1 Inviso 1.1 Introduction inviso : (Latin) to go to see, visit, inspect, look at. The Inviso trace system consists of one or several runtime components supposed to run on each Erlang node doing...
inviso_lfm
inviso_lfm MODULE inviso_lfm MODULE SUMMARY An Inviso Off-Line Logfile Merger DESCRIPTION Implements an off-line logfile merger, merging binary trace-log files from several nodes together in...
inviso_lfm_tpfreader
inviso_lfm_tpfreader MODULE inviso_lfm_tpfreader MODULE SUMMARY Inviso Standard Reader Process to Standard Logfile Merger DESCRIPTION Implements the standard reader process to the standard logfile...
inviso_rt
inviso_rt MODULE inviso_rt MODULE SUMMARY Direct API to the Inviso Runtime Component DESCRIPTION The inviso_rt API is normally only used when programming autostart scripts or similar mechanisms. The...
inviso_rt_meta
inviso_rt_meta MODULE inviso_rt_meta MODULE SUMMARY Direct API to the Inviso Runtime Component's meta tracer DESCRIPTION This module provides a direct API to the inviso meta tracer. These functions...
The Jinterface Package
1 The Jinterface Package The Jinterface package provides a set of tools for communication with Erlang processes. It can also be used for communication with other Java processes using the same...
Java-Erlang Interface Library: Class AbstractConnection
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: INNER | ...
Java-Erlang Interface Library: Class AbstractNode
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class GenericQueue
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpAuthException
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpConnection
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: INNER | ...
Java-Erlang Interface Library: Class OtpCookedConnection
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: INNER | ...
Java-Erlang Interface Library: Class OtpEpmd
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpErlangAtom
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: INNER | ...
Java-Erlang Interface Library: Class OtpErlangBinary
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: INNER | ...
Java-Erlang Interface Library: Class OtpErlangBitstr
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: INNER | ...
Java-Erlang Interface Library: Class OtpErlangBoolean
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: INNER | ...
Java-Erlang Interface Library: Class OtpErlangByte
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpErlangChar
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpErlangDecodeException
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpErlangDouble
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpErlangException
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpErlangExit
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpErlangFloat
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpErlangInt
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpErlangList
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpErlangLong
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpErlangObject
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpErlangPid
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpErlangPort
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpErlangRangeException
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpErlangRef
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpErlangShort
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpErlangString
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpErlangTuple
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpErlangUInt
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpErlangUShort
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpException
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpExternal
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: INNER | ...
Java-Erlang Interface Library: Class OtpInputStream
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: INNER | ...
Java-Erlang Interface Library: Class OtpLocalNode
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: INNER | ...
Java-Erlang Interface Library: Class OtpMbox
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpMsg
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: INNER | ...
Java-Erlang Interface Library: Class OtpNode.Acceptor
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: INNER | ...
Java-Erlang Interface Library: Class OtpNode
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: INNER | ...
Java-Erlang Interface Library: Class OtpNode.Mailboxes
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpNodeStatus
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpOutputStream
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: INNER | ...
Java-Erlang Interface Library: Class OtpPeer
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY:...
Java-Erlang Interface Library: Class OtpSelf
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: INNER | ...
Java-Erlang Interface Library: Class OtpServer
Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: INNER | ...
Java-Erlang Interface Library: Package com.ericsson.otp.erlang
com.ericsson.otp.erlang Classes AbstractConnection AbstractNode GenericQueue OtpConnection OtpCookedConnection OtpEpmd OtpErlangAtom OtpErlangBinary OtpErlangBitstr OtpErlangBoolean...
Java-Erlang Interface Library: Package com.ericsson.otp.erlang
Package Class Tree Deprecated Index Help PREV PACKAGE NEXT PACKAGE FRAMES NO FRAMES Package com.ericsson.otp.erlang...
Java-Erlang Interface Library: com.ericsson.otp.erlang Class Hierarchy
Package Class Tree Deprecated Index Help PREV NEXT FRAMES NO FRAMES Hierarchy For Package com.ericsson.otp.erlang...
app
app FILE app FILE SUMMARY Application resource file. DESCRIPTION The application resource file specifies the resources an application uses, and how the application is started. There must always be...
application
application MODULE application MODULE SUMMARY Generic OTP application functions DESCRIPTION In OTP, application denotes a component implementing some specific functionality, that can be started and...
auth
auth MODULE auth MODULE SUMMARY Erlang Network Authentication Server DESCRIPTION This module is deprecated. For a description of the Magic Cookie system, refer to Distributed Erlang in the Erlang...
code
code MODULE code MODULE SUMMARY Erlang Code Server DESCRIPTION This module contains the interface to the Erlang code server , which deals with the loading of compiled code into a running Erlang...
config
config FILE config FILE SUMMARY Configuration file. DESCRIPTION A configuration file contains values for configuration parameters for the applications in the system. The erl command line argument...
disk_log
disk_log MODULE disk_log MODULE SUMMARY A disk based term logging facility DESCRIPTION disk_log is a disk based term logger which makes it possible to efficiently log items on files. Two types of...
erl_boot_server
erl_boot_server MODULE erl_boot_server MODULE SUMMARY Boot Server for Other Erlang Machines DESCRIPTION This server is used to assist diskless Erlang nodes which fetch all Erlang code from another...
erl_ddll
erl_ddll MODULE erl_ddll MODULE SUMMARY Dynamic Driver Loader and Linker DESCRIPTION The erl_ddll module provides an interface for loading and unloading erlang linked in drivers in runtime. Note This...
erl_prim_loader
erl_prim_loader MODULE erl_prim_loader MODULE SUMMARY Low Level Erlang Loader DESCRIPTION erl_prim_loader is used to load all Erlang modules into the system. The start script is also fetched with...
erlang
erlang MODULE erlang MODULE SUMMARY The Erlang BIFs DESCRIPTION By convention, most built-in functions (BIFs) are seen as being in the module erlang . A number of the BIFs are viewed more or less as...
error_handler
error_handler MODULE error_handler MODULE SUMMARY Default System Error Handler DESCRIPTION The error handler module defines what happens when certain types of errors occur. EXPORTS...
error_logger
error_logger MODULE error_logger MODULE SUMMARY Erlang Error Logger DESCRIPTION The Erlang error logger is an event manager (see OTP Design Principles and gen_event(3) ), registered as error_logger ....
file
file MODULE file MODULE SUMMARY File Interface Module DESCRIPTION The module file provides an interface to the file system. On operating systems with thread support, it is possible to let file...
gen_sctp
gen_sctp MODULE gen_sctp MODULE SUMMARY The gen_sctp module provides functions for communicating with sockets using the SCTP protocol. DESCRIPTION The gen_sctp module provides functions for...
gen_tcp
gen_tcp MODULE gen_tcp MODULE SUMMARY Interface to TCP/IP sockets DESCRIPTION The gen_tcp module provides functions for communicating with sockets using the TCP/IP protocol. The following code...
gen_udp
gen_udp MODULE gen_udp MODULE SUMMARY Interface to UDP sockets DESCRIPTION The gen_udp module provides functions for communicating with sockets using the UDP protocol. DATA TYPES ip_address() see...
global
global MODULE global MODULE SUMMARY A Global Name Registration Facility DESCRIPTION This documentation describes the Global module which consists of the following functionalities: registration of...
global_group
global_group MODULE global_group MODULE SUMMARY Grouping Nodes to Global Name Registration Groups DESCRIPTION The global group function makes it possible to group the nodes in a system into...
heart
heart MODULE heart MODULE SUMMARY Heartbeat Monitoring of an Erlang Runtime System DESCRIPTION This modules contains the interface to the heart process. heart sends periodic heartbeats to an external...
inet
inet MODULE inet MODULE SUMMARY Access to TCP/IP Protocols DESCRIPTION Provides access to TCP/IP protocols. See also ERTS User's Guide, Inet configuration for more information on how to configure an...
init
init MODULE init MODULE SUMMARY Coordination of System Startup DESCRIPTION The init module is pre-loaded and contains the code for the init system process which coordinates the start-up of the...
kernel
kernel APPLICATION kernel APPLICATION SUMMARY The Kernel Application DESCRIPTION The Kernel application is the first application started. It is mandatory in the sense that the minimal system based on...
net_adm
net_adm MODULE net_adm MODULE SUMMARY Various Erlang Net Administration Routines DESCRIPTION This module contains various network utility functions. EXPORTS dns_hostname(Host) -> {ok, Name} |...
net_kernel
net_kernel MODULE net_kernel MODULE SUMMARY Erlang Networking Kernel DESCRIPTION The net kernel is a system process, registered as net_kernel , which must be running for distributed Erlang to work....
os
os MODULE os MODULE SUMMARY Operating System Specific Functions DESCRIPTION The functions in this module are operating system specific. Careless use of these functions will result in programs that...
packages
packages MODULE packages MODULE SUMMARY Packages in Erlang DESCRIPTION Introduction Packages are simply namespaces for modules. All old Erlang modules automatically belong to the top level...
pg2
pg2 MODULE pg2 MODULE SUMMARY Distributed Named Process Groups DESCRIPTION This module implements process groups. The groups in this module differ from the groups in the module pg in several ways. In...
rpc
rpc MODULE rpc MODULE SUMMARY Remote Procedure Call Services DESCRIPTION This module contains services which are similar to remote procedure calls. It also contains broadcast facilities and parallel...
seq_trace
seq_trace MODULE seq_trace MODULE SUMMARY Sequential Tracing of Messages DESCRIPTION Sequential tracing makes it possible to trace all messages resulting from one initial message. Sequential tracing...
user
user MODULE user MODULE SUMMARY Standard I/O Server DESCRIPTION user is a server which responds to all the messages defined in the I/O interface. The code in user.erl can be used as a model for...
wrap_log_reader
wrap_log_reader MODULE wrap_log_reader MODULE SUMMARY A function to read internally formatted wrap disk logs DESCRIPTION wrap_log_reader is a function to read internally formatted wrap disk logs,...
zlib
zlib MODULE zlib MODULE SUMMARY Zlib Compression interface. DESCRIPTION The zlib module provides an API for the zlib library (http://www.zlib.org). It is used to compress and decompress data. The...
megaco
megaco MODULE megaco MODULE SUMMARY Main API of the Megaco application DESCRIPTION Interface module for the Megaco application DATA TYPES action_request() = #'ActionRequest'{} action_reply() =...
Architecture
2 Architecture 2.1 Network view Megaco is a (master/slave) protocol for control of gateway functions at the edge of the packet network. Examples of this is IP-PSTN trunking gateways and analog line...
megaco_codec_meas
megaco_codec_meas MODULE megaco_codec_meas MODULE SUMMARY This module implements a simple megaco codec measurement tool. DESCRIPTION This module implements a simple megaco codec measurement tool....
megaco_codec_transform
megaco_codec_transform MODULE megaco_codec_transform MODULE SUMMARY Megaco message transformation utility. DESCRIPTION This module implements a simple megaco message transformation utility. Note that...
Testing and tools
9 Testing and tools 9.1 Tracing We have instrumented our code in order to enable tracing. Running the application with tracing deactivated, causes a neglectible performance overhead (an external call...
megaco_encoder
megaco_encoder MODULE megaco_edist_compress MODULE SUMMARY Megaco erlang dist compress behaviour. DESCRIPTION The following functions should be exported from a megaco_edist_compress callback module:...
Internal form and its encodings
4 Internal form and its encodings This version of the stack is compliant with: Megaco/H.248 version 1 (RFC3525) updated according to Implementors Guide version 10-13. Megaco/H.248 version 2 as...
megaco_encoder
megaco_encoder MODULE megaco_encoder MODULE SUMMARY Megaco encoder behaviour. DESCRIPTION The following functions should be exported from a megaco_encoder callback module: DATA TYPES megaco_message()...
Implementation examples
6 Implementation examples 6.1 A simple Media Gateway Controller In megaco/examples/simple/megaco_simple_mgc.erl there is an example of a simple MGC that listens on both text and binary standard ports...
megaco_flex_scanner
megaco_flex_scanner MODULE megaco_flex_scanner MODULE SUMMARY Interface module to the flex scanner linked in driver. DESCRIPTION This module contains the public interface to the flex scanner linked...
Introduction
1 Introduction Megaco/H.248 is a protocol for control of elements in a physically decomposed multimedia gateway, enabling separation of call control from media conversion. A Media Gateway Controller...
Megaco mib
7 Megaco mib 7.1 Intro The Megaco mib is as of yet not standardized and our implementation is based on draft-ietf-megaco-mib-04.txt . Almost all of the mib cannot easily be implemented by the megaco...
Performace comparison
8 Performace comparison 8.1 Comparison of encoder/decoders The Megaco/H.248 standard defines both a plain text encoding and a binary encoding (ASN.1 BER) and we have implemented encoders and decoders...
Running the stack
3 Running the stack 3.1 Starting A user may have a number of "virtual" connections to other users. An MG is connected to at most one MGC, while an MGC may be connected to any number of MG's. For each...
megaco_tcp
megaco_tcp MODULE megaco_tcp MODULE SUMMARY Interface module to TPKT transport protocol for Megaco/H.248. DESCRIPTION This module contains the public interface to the TPKT (TCP/IP) version transport...
megaco_transport
megaco_transport MODULE megaco_transport MODULE SUMMARY Megaco transport begaviour. DESCRIPTION The following functions should be exported from a megaco_transport callback module: send_message/2 [...
Transport mechanisms
5 Transport mechanisms 5.1 Callback interface The callback interface of the transport module contains several functions. Some of which are mandatory while others are only optional: send_message -...
megaco_udp
megaco_udp MODULE megaco_udp MODULE SUMMARY Interface module to UDP transport protocol for Megaco/H.248. DESCRIPTION This module contains the public interface to the UDP/IP version transport protocol...
megaco_user
megaco_user MODULE megaco_user MODULE SUMMARY Callback module for users of the Megaco application DESCRIPTION This module defines the callback behaviour of Megaco users. A megaco_user compliant...
rfc3015
Network Working Group F. Cuervo Request for Comments: 3015 N. Greene Obsoletes: 2885, 2886 A. Rayhan Category: Standards Track Nortel Networks C. Huitema Microsoft Corporation B. Rosen Marconi J....
mnesia
mnesia MODULE mnesia MODULE SUMMARY A Distributed Telecommunications DBMS DESCRIPTION Mnesia is a distributed DataBase Management System (DBMS), appropriate for telecommunications applications and...
Appendix A: Mnesia Error Messages
8 Appendix A: Mnesia Error Messages Whenever an operation returns an error in Mnesia, a description of the error is available. For example, the functions mnesia:transaction(Fun) , or...
Appendix B: The Backup Call Back Interface
9 Appendix B: The Backup Call Back Interface 9.1 mnesia_backup callback behavior %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% %% %% This module contains one implementation...
Appendix C: The Activity Access Call Back Interface
10 Appendix C: The Activity Access Call Back Interface 10.1 mnesia_access callback behavior -module(mnesia_frag). %% Callback functions when accessed within an activity -export([ lock/4, write/5,...
Appendix D: The Fragmented Table Hashing Call Back Interface
11 Appendix D: The Fragmented Table Hashing Call Back Interface 11.1 mnesia_frag_hash callback behavior -module(mnesia_frag_hash). %% Fragmented Table Hashing callback functions -export([...
Introduction
1 Introduction This book describes the Mnesia DataBase Management System (DBMS). Mnesia is a distributed Database Management System, appropriate for telecommunications applications and other Erlang...
Getting Started with Mnesia
2 Getting Started with Mnesia This chapter introduces Mnesia. Following a brief discussion about the first initial setup, a Mnesia database example is demonstrated. This database example will be...
Building A Mnesia Database
3 Building A Mnesia Database This chapter details the basic steps involved when designing a Mnesia database and the programming constructs which make different solutions available to the programmer....
Transactions and Other Access Contexts
4 Transactions and Other Access Contexts This chapter describes the Mnesia transaction system and the transaction properties which make Mnesia a fault tolerant, distributed database management...
Miscellaneous Mnesia Features
5 Miscellaneous Mnesia Features The earlier chapters of this User Guide described how to get started with Mnesia, and how to build a Mnesia database. In this chapter, we will describe the more...
Mnesia System Information
6 Mnesia System Information 6.1 Database Configuration Data The following two functions can be used to retrieve system information. They are described in detail in the reference manual....
Combining Mnesia with SNMP
7 Combining Mnesia with SNMP 7.1 Combining Mnesia and SNMP Many telecommunications applications must be controlled and reconfigured remotely. It is sometimes an advantage to perform this remote...
mnesia_frag_hash
mnesia_frag_hash MODULE mnesia_frag_hash MODULE SUMMARY Defines mnesia_frag_hash callback behaviour DESCRIPTION The module mnesia_frag_hash defines a callback behaviour for user defined hash...
mnesia_registry
mnesia_registry MODULE mnesia_registry MODULE SUMMARY Dump support for registries in erl_interface. DESCRIPTION The module mnesia_registry is usually part of erl_interface , but for the time being,...
crashdump_viewer
crashdump_viewer MODULE crashdump_viewer MODULE SUMMARY A HTML based tool for browsing Erlang crashdumps. DESCRIPTION The Crashdump Viewer is an HTML based tool for browsing Erlang crashdumps....
Crashdump Viewer help
Information pages Each menu item points to an information page. If no information is found for an item, the page will simply say "No information found". The reason for not finding any information...
Crashdump Viewer
3 Crashdump Viewer 3.1 Introduction The Crashdump Viewer is an HTML based tool for browsing Erlang crashdumps. Crashdump Viewer runs under the WebTool application. 3.2 Getting Started From an erlang...
etop
etop MODULE etop MODULE SUMMARY Erlang Top is a tool for presenting information about erlang processes similar to the information presented by "top" in UNIX. DESCRIPTION etop should be started with...
Erlang Top
2 Erlang Top 2.1 Introduction Erlang Top, etop is a tool for presenting information about erlang processes similar to the information presented by top in UNIX. 2.2 Output The output from etop can be...
observer
observer APPLICATION observer APPLICATION SUMMARY The Observer Application DESCRIPTION This chapter describes the OBSERVER application in OTP, which provides tools for tracing and investigation of...
ttb
ttb MODULE ttb MODULE SUMMARY A base for building trace tools for distributed systems. DESCRIPTION The Trace Tool Builder ttb is a base for building trace tools for distributed systems. When using...
Trace Tool Builder
1 Trace Tool Builder 1.1 Introduction The Trace Tool Builder is a base for building trace tools for single node or distributed erlang systems. It requires the runtime_tools application to be...
Databases
3 Databases 3.1 Databases If you need to access a relational database such as sqlserver , mysql , postgres , oracle , cybase etc. from your erlang application using the Erlang ODBC interface is a...
Error handling
4 Error handling 4.1 Strategy On a conceptual level starting a database connection using the Erlang ODBC API is a basic client server application. The client process uses the API to start and...
Getting started
2 Getting started 2.1 Setting things up As the Erlang ODBC application is dependent on third party products there are a few administrative things that needs to be done before you can get things up...
odbc
odbc MODULE odbc MODULE SUMMARY Erlang ODBC application DESCRIPTION This application provides an Erlang interface to communicate with relational SQL-databases. It is built on top of Microsofts ODBC...
any
any MODULE any MODULE SUMMARY the corba any type DESCRIPTION This module contains functions that gives an interface to the CORBA any type. Note that the any interface in orber does not contain a...
Debugging
14 Debugging 14.1 Tools and FAQ Persons who use Orber for the first time may find it hard to tell what goes wrong when trying to setup communication between an Orber-ORB and ORB:s supplied by another...
CORBA System and User Defined Exceptions
11 CORBA System and User Defined Exceptions 11.1 System Exceptions Orber , or any other ORB , may raise a System Exceptions . These exceptions contain status- and minor-fields and may not appear in...
OMG IDL to Erlang Mapping
6 OMG IDL to Erlang Mapping 6.1 OMG IDL to Erlang Mapping - Overview The purpose of OMG IDL, Interface Definition Language , mapping is to act as translator between platforms and languages. An IDL...
Interface Repository
4 Interface Repository 4.1 Interface Repository(IFR) The IFR is an interface repository built on the Mnesia application. Orber uses the IFR for some type-checking when coding/decoding IIOP. The IFR...