Interface BufferProtocol

    • Method Detail

      • getBuffer

        PyBuffer getBuffer​(int flags)
                    throws PyException,
                           java.lang.ClassCastException
        Method by which the consumer requests the buffer from the exporter. The consumer provides information on its ability to understand buffer navigation. Each consumer requesting a buffer in this way, when it has finished using it, should make a corresponding call to PyBuffer.release() on the buffer it obtained, or PyBuffer.close() using try-with-resources, since some objects alter their behaviour while buffers are exported.
        Parameters:
        flags - specifying features demanded and the navigational capabilities of the consumer
        Returns:
        exported buffer
        Throws:
        PyException - BufferError when expectations do not correspond with the buffer
        java.lang.ClassCastException - when the object only formally implements BufferProtocol