Module uxtr

UXTR: Universal Links Extractor main API.

Copyright 2010-2013 ALEPH ARCHIVES Ltd. All rights reserved.

Version: 1.0.0

Authors: Aleph Archives Ltd. [web site: http://aleph-archives.com/].

Description

UXTR: Universal Links Extractor main API.

Data Types

metric()

metric() = {pid(), [term()]}

uxtr()

uxtr() = #uxtr{}

Function Index

abort/1Try to abort an eventually active links extractor.
down/0 Turn down all running UXTR CPP engines.
halt/1Halt the extractor.
metrics/0Gather metrics about all running UXTR instances.
metrics/1Gather metrics about a specific UXTR instance.
restart/0handy shortcut to restart the application while it's running.
revision/0Returns the current revision number.
start/0Equivalent to application:start(uxtr).
stop/0Equivalent to application:stop(uxtr).
top/0Top-like summary for all running UXTR instances.
top/1Top-like summary for a specific UXTR instance.
up/0 Equivalent to up(Number Of CPU Cores).
up/1 Turn on "N" UXTR CPP engines.
version/0Returns the current version number.
xtract/1Equivalent to xrtact(Url, 'll').
xtract/2Extract links from the specific URL.

Function Details

abort/1

abort(Uxtr::#uxtr{}) -> ok

Try to abort an eventually active links extractor.

down/0

down() -> ok

Turn down all running UXTR CPP engines.

halt/1

halt(Uxtr::#uxtr{}) -> ok

Halt the extractor.

metrics/0

metrics() -> [metric()]

Gather metrics about all running UXTR instances.

metrics/1

metrics(Pid::pid()) -> metric()

Gather metrics about a specific UXTR instance.

restart/0

restart() -> ok

handy shortcut to restart the application while it's running

revision/0

revision() -> string()

Returns the current revision number.

start/0

start() -> ok

Equivalent to application:start(uxtr).

stop/0

stop() -> ok

Equivalent to application:stop(uxtr).

top/0

top() -> ok

Top-like summary for all running UXTR instances.

top/1

top(Pid::pid()) -> ok

Top-like summary for a specific UXTR instance.

up/0

up() -> ok

Equivalent to up(Number Of CPU Cores).

up/1

up(N::pos_integer()) -> ok

Turn on "N" UXTR CPP engines.

version/0

version() -> string()

Returns the current version number.

xtract/1

xtract(Url::list() | binary()) -> {ok, #uxtr{}} | {error, term()}

Equivalent to xrtact(Url, 'll').

xtract/2

xtract(Url::list() | binary(), Balance::uxtr_bal:strategy()) -> {ok, #uxtr{}} | {error, term()}

Extract links from the specific URL.


Generated by EDoc, Nov 12 2013, 14:34:17.