fail_over.h revision b8ecc581cdd8c7d097bf9db67a4cb220fbbcff6d
53bd0c89aa4743dc41a6394db5a90717c1ca4517Liam O'Reilly Fail over helper functions.
53bd0c89aa4743dc41a6394db5a90717c1ca4517Liam O'Reilly Martin Nagy <mnagy@redhat.com>
53bd0c89aa4743dc41a6394db5a90717c1ca4517Liam O'Reilly Copyright (C) Red Hat, Inc 2009
53bd0c89aa4743dc41a6394db5a90717c1ca4517Liam O'Reilly This program is free software; you can redistribute it and/or modify
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reilly it under the terms of the GNU General Public License as published by
53bd0c89aa4743dc41a6394db5a90717c1ca4517Liam O'Reilly the Free Software Foundation; either version 3 of the License, or
53bd0c89aa4743dc41a6394db5a90717c1ca4517Liam O'Reilly (at your option) any later version.
9aeda2b3ae8ce0b018955521e4ca835a8ba8a27bLiam O'Reilly This program is distributed in the hope that it will be useful,
57221209d11b05aa0373cc3892d5df89ba96ebf9Christian Maeder but WITHOUT ANY WARRANTY; without even the implied warranty of
66bc8d6e69cde43f1ccbeb76104cf7b8038acd6cChristian Maeder MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
66bc8d6e69cde43f1ccbeb76104cf7b8038acd6cChristian Maeder GNU General Public License for more details.
d5833d2ee7bafcbf2fdd2bdfd9a728c769b100c7Christian Maeder You should have received a copy of the GNU General Public License
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reilly along with this program. If not, see <http://www.gnu.org/licenses/>.
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reilly/* Some forward declarations that don't have to do anything with fail over. */
2a5b885d9350ec6dd8bc4992ee91d2f68aa592f4Christian Maeder PORT_NEUTRAL, /* We didn't try this port yet. */
f21c7417bdd1c0282025cba0f5cb0ff5bc5c98eeLiam O'Reilly PORT_WORKING, /* This port was reported to work. */
53bd0c89aa4743dc41a6394db5a90717c1ca4517Liam O'Reilly PORT_NOT_WORKING /* This port was reported to not work. */
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reilly SERVER_NAME_NOT_RESOLVED, /* We didn't yet resolved the host name. */
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reilly SERVER_RESOLVING_NAME, /* Name resolving is in progress. */
9e5f4073e948104307d43c3962d624b8416f191fLiam O'Reilly SERVER_NAME_RESOLVED, /* We resolved the host name but didn't try to connect. */
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder SERVER_WORKING, /* We successfully connected to the server. */
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder SERVER_NOT_WORKING /* We tried and failed to connect to the server. */
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder * Failover settings.
4314e26a12954cb1c9be4dea10aa8103edac5bbbChristian Maeder * The 'retry_timeout' member specifies the
d5833d2ee7bafcbf2fdd2bdfd9a728c769b100c7Christian Maeder * duration in seconds of how long a server or port will be considered
d5833d2ee7bafcbf2fdd2bdfd9a728c769b100c7Christian Maeder * non-working after being marked as such.
9aeda2b3ae8ce0b018955521e4ca835a8ba8a27bLiam O'Reilly * The 'service_resolv_timeout' member specifies how long we wait for
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reilly * service resolution. When this timeout is reached, the resolve request
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder * is cancelled with an error
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder * The 'srv_retry_timeout' member specifies how long a SRV lookup
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder * is considered valid until we ask the server again.
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder * The family_order member specifies the order of address families to
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reilly * try when looking up the service.
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * Create a new fail over context based on options passed in the
fa373bc327620e08861294716b4454be8d25669fChristian Maeder * opts parameter
648fe1220044aac847acbdfbc4155af5556063ebChristian Maederstruct fo_ctx *fo_context_init(TALLOC_CTX *mem_ctx,
e8d99f05c231b379be702a1aa8c7dd0b3c666928Liam O'Reilly * Create a new service structure for 'ctx', saving it to the location pointed
7857a35e3af533dfbd0f0e18638ebd211e6358a0Christian Maeder * to by '_service'. The needed memory will be allocated from 'ctx'.
7857a35e3af533dfbd0f0e18638ebd211e6358a0Christian Maeder * Service name will be set to 'name'.
e8d99f05c231b379be702a1aa8c7dd0b3c666928Liam O'Reilly * Look up service named 'name' from the 'ctx' service list. Target of
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder * '_service' will be set to the service if it was found.
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder * Get number of servers registered for the 'service'.
648fe1220044aac847acbdfbc4155af5556063ebChristian Maederint fo_get_server_count(struct fo_service *service);
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder * Adds a server 'name' to the 'service'. Port 'port' will be used for
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder * connection. If 'name' is NULL, no server resolution will be done.
eb48217dfa67ddb87b8fbd846de293d0636bd578Christian Maederint fo_add_server(struct fo_service *service,
7830e8fa7442fb7452af7ecdba102bc297ae367eChristian Maederint fo_add_srv_server(struct fo_service *service,
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder * Request the first server from the service's list of servers. It is only
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder * considered if it is not marked as not working (or the retry interval already
4314e26a12954cb1c9be4dea10aa8103edac5bbbChristian Maeder * passed). If the server address wasn't resolved yet, it will be done.
648fe1220044aac847acbdfbc4155af5556063ebChristian Maederstruct tevent_req *fo_resolve_service_send(TALLOC_CTX *mem_ctx,
4314e26a12954cb1c9be4dea10aa8103edac5bbbChristian Maederint fo_resolve_service_recv(struct tevent_req *req,
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reilly * Set feedback about 'server'. Caller should use this to indicate a problem
d5833d2ee7bafcbf2fdd2bdfd9a728c769b100c7Christian Maeder * with the server itself, not only with the service on that server. This
d5833d2ee7bafcbf2fdd2bdfd9a728c769b100c7Christian Maeder * should be used, for example, when the IP address of the server can't be
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder * reached. This setting can affect other services as well, since they can
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder * share the same server.
e0f1794e365dd347e97b37d7d22b2fce27296fa1Christian Maedervoid fo_set_server_status(struct fo_server *server,
7857a35e3af533dfbd0f0e18638ebd211e6358a0Christian Maeder * Set feedback about the port status. This function should be used when
7857a35e3af533dfbd0f0e18638ebd211e6358a0Christian Maeder * the server itself is working but the service is not. When status is set
2a5b885d9350ec6dd8bc4992ee91d2f68aa592f4Christian Maeder * to PORT_WORKING, 'server' is also marked as an "active server" for its
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder * service. When the next fo_resolve_service_send() function is called, this
2a5b885d9350ec6dd8bc4992ee91d2f68aa592f4Christian Maeder * server will be preferred. This will hold as long as it is not marked as
7857a35e3af533dfbd0f0e18638ebd211e6358a0Christian Maeder * not-working.
7857a35e3af533dfbd0f0e18638ebd211e6358a0Christian Maedervoid fo_set_port_status(struct fo_server *server,
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder * Instruct fail-over to try next server on the next connect attempt.
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder * Should be used after connection to service was unexpectedly dropped
648fe1220044aac847acbdfbc4155af5556063ebChristian Maeder * but there is no authoritative information on whether active server is down.
648fe1220044aac847acbdfbc4155af5556063ebChristian Maedervoid fo_try_next_server(struct fo_service *service);
648fe1220044aac847acbdfbc4155af5556063ebChristian Maedervoid *fo_get_server_user_data(struct fo_server *server);
33bdce26495121cdbce30331ef90a1969126a840Liam O'Reillyint fo_get_server_port(struct fo_server *server);
bc350328e6ac2d9074317e222b4207a6aa49afeaLiam O'Reillyconst char *fo_get_server_name(struct fo_server *server);
f21c7417bdd1c0282025cba0f5cb0ff5bc5c98eeLiam O'Reillyconst char *fo_get_server_str_name(struct fo_server *server);
f21c7417bdd1c0282025cba0f5cb0ff5bc5c98eeLiam O'Reillystruct resolv_hostent *fo_get_server_hostent(struct fo_server *server);
f19dc06364e8d6ea36f7c170e1f7a0677de63184Liam O'Reillytime_t fo_get_server_hostname_last_change(struct fo_server *server);
bc350328e6ac2d9074317e222b4207a6aa49afeaLiam O'Reilly#endif /* !__FAIL_OVER_H__ */