Xapian::Remote Namespace Reference

Database factory functions for the remote backend. More...

Functions
Database	open (std::string_view host, unsigned int port, unsigned timeout=10000, unsigned connect_timeout=10000)
	Construct a Database object for read-only access to a remote database accessed via a TCP connection. More...
WritableDatabase	open_writable (std::string_view host, unsigned int port, unsigned timeout=0, unsigned connect_timeout=10000, int flags=0)
	Construct a WritableDatabase object for update access to a remote database accessed via a TCP connection. More...
Database	open (std::string_view program, std::string_view args, unsigned timeout=10000)
	Construct a Database object for read-only access to a remote database accessed via a program. More...
WritableDatabase	open_writable (std::string_view program, std::string_view args, unsigned timeout=0, int flags=0)
	Construct a WritableDatabase object for update access to a remote database accessed via a program. More...

Detailed Description

Database factory functions for the remote backend.

Function Documentation

open() [1/2]

Database Xapian::Remote::open	(	std::string_view	host,
		unsigned int	port,
		unsigned	timeout = 10000,
		unsigned	connect_timeout = 10000
	)

Construct a Database object for read-only access to a remote database accessed via a TCP connection.

Access to the remote database is via a TCP connection to the specified host and port.

Parameters

host	hostname to connect to.
port	port number to connect to.
timeout	timeout in milliseconds. If this timeout is exceeded for any individual operation on the remote database then Xapian::NetworkTimeoutError is thrown. A timeout of 0 means don't timeout. (Default is 10000ms, which is 10 seconds).
connect_timeout	timeout to use when connecting to the server. If this timeout is exceeded then Xapian::NetworkTimeoutError is thrown. A timeout of 0 means don't timeout. (Default is 10000ms, which is 10 seconds).

Definition at line 36 of file dbfactory_remote.cc.

References LOGCALL_STATIC, and RETURN.

Referenced by apply_changeset(), Xapian::DatabaseReplica::Internal::apply_next_changeset(), Xapian::Internal::closefrom(), GlassDatabase::compact(), HoneyDatabase::compact(), DEFINE_TESTCASE(), Uuid::generate(), get_changeset(), BackendManagerRemoteProg::get_database_by_path(), BackendManagerRemoteProg::get_remote_database(), get_remotetcp_db(), BackendManagerRemoteProg::get_writable_database_as_database(), io_open_block_rd(), io_open_block_wr(), io_open_stream_rd(), io_open_stream_wr(), FlintLock::lock(), main(), Xapian::open_stub(), test_driver::parse_command_line(), Xapian::DatabaseReplica::Internal::possibly_make_offline_live(), ProgClient::run_program(), FlintLock::test(), touch(), and truncated_copy().

open() [2/2]

Database Xapian::Remote::open	(	std::string_view	program,
		std::string_view	args,
		unsigned	timeout = 10000
	)

Construct a Database object for read-only access to a remote database accessed via a program.

Access to the remote database is done by running an external program and communicating with it on stdin/stdout.

Parameters

program	the external program to run.
args	space-separated list of arguments to pass to program.
timeout	timeout in milliseconds. If this timeout is exceeded for any individual operation on the remote database then Xapian::NetworkTimeoutError is thrown. A timeout of 0 means don't timeout. (Default is 10000ms, which is 10 seconds).

Definition at line 56 of file dbfactory_remote.cc.

References LOGCALL_STATIC, and RETURN.

open_writable() [1/2]

WritableDatabase Xapian::Remote::open_writable	(	std::string_view	host,
		unsigned int	port,
		unsigned	timeout = 0,
		unsigned	connect_timeout = 10000,
		int	flags = 0
	)

Construct a WritableDatabase object for update access to a remote database accessed via a TCP connection.

Access to the remote database is via a TCP connection to the specified host and port.

Parameters

host	hostname to connect to.
port	port number to connect to.
timeout	timeout in milliseconds. If this timeout is exceeded for any individual operation on the remote database then Xapian::NetworkTimeoutError is thrown. (Default is 0, which means don't timeout).
connect_timeout	timeout to use when connecting to the server. If this timeout is exceeded then Xapian::NetworkTimeoutError is thrown. A timeout of 0 means don't timeout. (Default is 10000ms, which is 10 seconds).
flags	Xapian::DB_RETRY_LOCK or 0.

Definition at line 45 of file dbfactory_remote.cc.

References LOGCALL_STATIC, and RETURN.

Referenced by BackendManagerRemoteProg::get_remote_writable_database(), get_remotetcp_writable_db(), BackendManagerRemoteProg::get_writable_database(), BackendManagerRemoteProg::get_writable_database_again(), and Xapian::open_stub().

open_writable() [2/2]

WritableDatabase Xapian::Remote::open_writable	(	std::string_view	program,
		std::string_view	args,
		unsigned	timeout = 0,
		int	flags = 0
	)

Construct a WritableDatabase object for update access to a remote database accessed via a program.

Access to the remote database is done by running an external program and communicating with it on stdin/stdout.

Parameters

program	the external program to run.
args	space-separated list of arguments to pass to program.
timeout	timeout in milliseconds. If this timeout is exceeded for any individual operation on the remote database then Xapian::NetworkTimeoutError is thrown. (Default is 0, which means don't timeout).
flags	Xapian::DB_RETRY_LOCK or 0.

Definition at line 64 of file dbfactory_remote.cc.

References LOGCALL_STATIC, and RETURN.