Return to xnscourier.n CVS log

Up to [CSRG BSD Unix] / 43BSD / contrib / xns / doc

Annotation of 43BSD/contrib/xns/doc/xnscourier.n, revision 1.1

1.1     ! root        1: .TH Courier 3 Cornell
        !             2: .SH NAME
        !             3: CourierOpen, CourierClose, BDTread, BDTwrite, BDTabort, BDTclosewrite \-
        !             4: public runtimes for Unix Courier
        !             5: .SH SYNOPSIS
        !             6: .nf
        !             7: .B #include <xnscourier/courier.h>
        !             8: .B #include <xnscourier/courierconnection.h>
        !             9: .PP
        !            10: .B CourierConnection *CourierOpen(destaddr)
        !            11: .B struct xn_addr *destaddr;
        !            12: .PP
        !            13: .B CourierClose(conn)
        !            14: .B CourierConnection *conn;
        !            15: .PP
        !            16: .B int BDTread(conn, buffer, nbytes)
        !            17: .B CourierConnection *conn;
        !            18: .B char *buffer;
        !            19: .B int nbytes;
        !            20: .PP
        !            21: .B int BDTwrite(conn, buffer, nbytes)
        !            22: .B CourierConnection *conn;
        !            23: .B char *buffer;
        !            24: .B int nbytes;
        !            25: .PP
        !            26: .B BDTclosewrite(conn)
        !            27: .B CourierConnection *conn;
        !            28: .PP
        !            29: .B BDTabort(conn)
        !            30: .B CourierConnection *conn;
        !            31: .PP
        !            32: cc ... -lcourier
        !            33: .fi
        !            34: .SH DESCRIPTION
        !            35: .PP
        !            36: These functions are part of the runtime library for XNS Courier remote
        !            37: procedure calls.  They all require the Maryland XNS kernel.
        !            38: .PP
        !            39: .I CourierOpen
        !            40: attempts to open an SPP connection to the address specified.  It returns
        !            41: 0 on failure.
        !            42: .PP
        !            43: .I CourierClose
        !            44: closes the SPP connection obtained by CourierOpen by means of the usual
        !            45: XNS 3-way END/END-REPLY handshake.
        !            46: .PP
        !            47: .I BDTread
        !            48: and
        !            49: .I BDTwrite
        !            50: are similar to 
        !            51: .I read(2)
        !            52: and
        !            53: .I write(2)
        !            54: except that they accept a Courier connection instead of a file descriptor,
        !            55: and transmit or receive at most one SPP packet (maximum size is thus 534
        !            56: bytes, which is also the recommended value of 
        !            57: .IR nbytes ).
        !            58: These routines should be used only in a Courier server to perform a BDT
        !            59: data transfer, or in a Courier client from within a BDT callback routine.
        !            60: .PP
        !            61: .I BDTclosewrite
        !            62: and
        !            63: .I BDTabort
        !            64: provide a way for a BDT source (i.e. write)
        !            65: procedure to end a data transfer, either successfully
        !            66: or unsuccessfully respectively.  In addition, 
        !            67: .I BDTabort
        !            68: may be used to terminate a BDT sink (i.e. read) transfer.
        !            69: .SH FILES
        !            70: .nf
        !            71: .fi
        !            72: .SH SEE ALSO
        !            73: all the Courier documentation
        !            74: .SH DIAGNOSTICS
        !            75: None.
        !            76: .SH BUGS
        !            77: Probably lots of them.  Expanding ring broadcast is not yet implemented.

This archive runs on limited infrastructure. Preserving old code on modern bandwidth. Automated agents are requested to crawl responsibly.