<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--NewPage-->
<HTML>
<HEAD>
<!-- Generated by javadoc (build 1.6.0_18) on Thu Dec 02 16:59:42 UTC 2010 -->
<TITLE>
DbRepTransport
</TITLE>
<META NAME="date" CONTENT="2010-12-02">
<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
<SCRIPT type="text/javascript">
function windowTitle()
{
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="DbRepTransport";
}
}
</SCRIPT>
<NOSCRIPT>
</NOSCRIPT>
</HEAD>
<BODY BGCOLOR="white" onload="windowTitle();">
<HR>
<!-- ========= START OF TOP NAVBAR ======= -->
<A NAME="navbar_top"><!-- --></A>
<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_top_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../com/sleepycat/db/DbRepStat.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A>
<A HREF="../../../com/sleepycat/db/DbRunRecoveryException.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?com/sleepycat/db/DbRepTransport.html" target="_top"><B>FRAMES</B></A>
<A HREF="DbRepTransport.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_top"></A>
<!-- ========= END OF TOP NAVBAR ========= -->
<HR>
<!-- ======== START OF CLASS DATA ======== -->
<H2>
<FONT SIZE="-1">
com.sleepycat.db</FONT>
<BR>
Interface DbRepTransport</H2>
<HR>
<DL>
<DT><PRE>public interface <B>DbRepTransport</B></DL>
</PRE>
<P>
An interface specifying a replication transmit function, which
sends information to other members of the replication group.</p>
<P>
<P>
<HR>
<P>
<!-- ========== METHOD SUMMARY =========== -->
<A NAME="method_summary"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
<B>Method Summary</B></FONT></TH>
</TR>
<TR BGCOLOR="white" CLASS="TableRowColor">
<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
<CODE> int</CODE></FONT></TD>
<TD><CODE><B><A HREF="../../../com/sleepycat/db/DbRepTransport.html#send(com.sleepycat.db.DbEnv, com.sleepycat.db.Dbt, com.sleepycat.db.Dbt, com.sleepycat.db.DbLsn, int, int)">send</A></B>(<A HREF="../../../com/sleepycat/db/DbEnv.html" title="class in com.sleepycat.db">DbEnv</A> dbenv,
<A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db">Dbt</A> control,
<A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db">Dbt</A> rec,
<A HREF="../../../com/sleepycat/db/DbLsn.html" title="class in com.sleepycat.db">DbLsn</A> lsn,
int flags,
int envid)</CODE>
<BR>
The DbRepTransport interface is used by the
DbEnv.setReplicationTransport method.</TD>
</TR>
</TABLE>
<P>
<!-- ============ METHOD DETAIL ========== -->
<A NAME="method_detail"><!-- --></A>
<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
<B>Method Detail</B></FONT></TH>
</TR>
</TABLE>
<A NAME="send(com.sleepycat.db.DbEnv, com.sleepycat.db.Dbt, com.sleepycat.db.Dbt, com.sleepycat.db.DbLsn, int, int)"><!-- --></A><H3>
send</H3>
<PRE>
int <B>send</B>(<A HREF="../../../com/sleepycat/db/DbEnv.html" title="class in com.sleepycat.db">DbEnv</A> dbenv,
<A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db">Dbt</A> control,
<A HREF="../../../com/sleepycat/db/Dbt.html" title="class in com.sleepycat.db">Dbt</A> rec,
<A HREF="../../../com/sleepycat/db/DbLsn.html" title="class in com.sleepycat.db">DbLsn</A> lsn,
int flags,
int envid)
throws <A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></PRE>
<DL>
<DD>The DbRepTransport interface is used by the
DbEnv.setReplicationTransport method. This interface defines
the application-specific function to be called during
transaction abort and recovery.</p> It may sometimes be useful
to pass application-specific data to the <b>send</b> function;
see <a href="../../../../ref/env/faq.html">Environment FAQ
</a> for a discussion on how to do this.</p>
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>dbenv</CODE> - the enclosing database environment
handle.<DD><CODE>control</CODE> - the first of the two data elements to be
transmitted by the <b>send</b> function.<DD><CODE>rec</CODE> - the second of the two data elements to be
transmitted by the <b>send</b> function.<DD><CODE>lsn</CODE> - If the type of message to be sent has an
LSN associated with it, then the <b>lsn</b> parameter
contains the LSN of the record being sent. This LSN can be
used to determine that certain records have been processed
successfully by clients.<DD><CODE>envid</CODE> - a positive integer identifier that
specifies the replication environment to which the message
should be sent (see <a href="../../../../ref/rep/id.html">
Replication environment IDs</a> for more information).
<ul>
<li> <A HREF="../../../com/sleepycat/db/Db.html#DB_EID_BROADCAST"><CODE>Db.DB_EID_BROADCAST</CODE></A><p>
The special identifier <code>Db.DB_EID_BROADCAST</code>
indicates that a message should be broadcast to every
environment in the replication group. The application
may use a true broadcast protocol or may send the
message in sequence to each machine with which it is in
communication. In both cases, the sending site should
not be asked to process the message.</p> </li>
</ul><DD><CODE>flags</CODE> - must be set to 0 or by bitwise
inclusively <b>OR</b> 'ing together one or more of the
following values:
<ul>
<li> <A HREF="../../../com/sleepycat/db/Db.html#DB_REP_NOBUFFER"><CODE>Db.DB_REP_NOBUFFER</CODE></A><p>
The record being sent should be transmitted immediately
and not buffered or delayed. </li>
</ul>
<ul>
<li> <A HREF="../../../com/sleepycat/db/Db.html#DB_REP_PERMANENT"><CODE>Db.DB_REP_PERMANENT</CODE></A><p>
The record being sent is critical for maintaining
database integrity (for example, the message includes a
transaction commit). The application should take
appropriate action to enforce the reliability guarantees
it has chosen, such as waiting for acknowledgement from
one or more clients. </li>
</ul>
<DT><B>Returns:</B><DD>The <b>send</b> function should not call
back down into Berkeley DB. The <b>send</b> function must
return 0 on success and non-zero on failure. If the <b>
send</b> function fails, the message being sent is
necessary to maintain database integrity, and the local
log is not configured for synchronous flushing, the local
log will be flushed; otherwise, any error from the <b>send
</b> function will be ignored.</p>
<DT><B>Throws:</B>
<DD><CODE><A HREF="../../../com/sleepycat/db/DbException.html" title="class in com.sleepycat.db">DbException</A></CODE> - Signals that an exception of some sort
has occurred.</DL>
</DD>
</DL>
<!-- ========= END OF CLASS DATA ========= -->
<HR>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<A NAME="navbar_bottom"><!-- --></A>
<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
<TR>
<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
<A NAME="navbar_bottom_firstrow"><!-- --></A>
<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
<TR ALIGN="center" VALIGN="top">
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD>
<TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD>
<TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD>
</TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>
<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../com/sleepycat/db/DbRepStat.html" title="class in com.sleepycat.db"><B>PREV CLASS</B></A>
<A HREF="../../../com/sleepycat/db/DbRunRecoveryException.html" title="class in com.sleepycat.db"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
<A HREF="../../../index.html?com/sleepycat/db/DbRepTransport.html" target="_top"><B>FRAMES</B></A>
<A HREF="DbRepTransport.html" target="_top"><B>NO FRAMES</B></A>
<SCRIPT type="text/javascript">
<!--
if(window==top) {
document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
}
//-->
</SCRIPT>
<NOSCRIPT>
<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
</NOSCRIPT>
</FONT></TD>
</TR>
<TR>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
SUMMARY: NESTED | FIELD | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<HR>
</BODY>
</HTML>
