ssh

Class ssh_socket_callbacks_struct

java.lang.Object

com.sun.jna.Structure

com.ochafik.lang.jnaerator.runtime.Structure<ssh_socket_callbacks_struct,ssh_socket_callbacks_struct.ByValue,ssh_socket_callbacks_struct.ByReference>

ssh.ssh_socket_callbacks_struct

All Implemented Interfaces:

com.ochafik.lang.jnaerator.runtime.StructureType, com.ochafik.lang.jnaerator.runtime.StructureTypeDependent, java.lang.Comparable<com.ochafik.lang.jnaerator.runtime.Structure<ssh_socket_callbacks_struct,ssh_socket_callbacks_struct.ByValue,ssh_socket_callbacks_struct.ByReference>>

Direct Known Subclasses:

ssh_socket_callbacks_struct.ByReference, ssh_socket_callbacks_struct.ByValue

public class ssh_socket_callbacks_struct
extends com.ochafik.lang.jnaerator.runtime.Structure<ssh_socket_callbacks_struct,ssh_socket_callbacks_struct.ByValue,ssh_socket_callbacks_struct.ByReference>

These are the callbacks exported by the socket structure
They are called by the socket module when a socket event appears
native declaration : /usr/include/libssh/callbacks.h:146
This file was autogenerated by JNAerator,
a tool written by Olivier Chafik that uses a few opensource projects..
For help, please visit NativeLibs4Java , Rococoa, or JNA.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ssh_socket_callbacks_struct.ByReference
static class	ssh_socket_callbacks_struct.ByValue

Nested classes/interfaces inherited from class com.sun.jna.Structure

com.sun.jna.Structure.StructField

Field Summary

Fields

Modifier and Type	Field and Description
SshLibrary.ssh_callback_int_int	connected This function is called when the ssh_socket_connect was used on the socket on nonblocking state, and the connection successed. C type : ssh_callback_int_int
SshLibrary.ssh_callback_int	controlflow This function will be called each time a controlflow state changes, i.e. the socket is available for reading or writing. C type : ssh_callback_int
SshLibrary.ssh_callback_data	data This function will be called each time data appears on socket.
SshLibrary.ssh_callback_int_int	exception This function will be called each time an exception appears on socket.
com.sun.jna.Pointer	userdata User-provided data.

Fields inherited from class com.sun.jna.Structure

ALIGN_DEFAULT, ALIGN_GNUC, ALIGN_MSVC, ALIGN_NONE, CALCULATE_SIZE

Constructor Summary

Constructors

Constructor and Description
ssh_socket_callbacks_struct()
ssh_socket_callbacks_struct(com.sun.jna.Pointer userdata, SshLibrary.ssh_callback_data data, SshLibrary.ssh_callback_int controlflow, SshLibrary.ssh_callback_int_int exception, SshLibrary.ssh_callback_int_int connected)

Method Summary

Modifier and Type	Method and Description
protected void	initFieldOrder()
static ssh_socket_callbacks_struct[]	newArray(int arrayLength)
protected ssh_socket_callbacks_struct.ByReference	newByReference()
protected ssh_socket_callbacks_struct.ByValue	newByValue()
protected ssh_socket_callbacks_struct	newInstance()

Methods inherited from class com.ochafik.lang.jnaerator.runtime.Structure

byReference, byValue, castToArray, castToArray, castToArray, castToReferenceArray, castToReferenceArray, castToValueArray, castToValueArray, clone, compareTo, getBitsAnnotation, newArray, read, readDependency, setDependency, setupClone, setupClone, toArray, toArray, toArray, toReferenceArray, toReferenceArray, toValueArray, toValueArray, use, use, use, use, write

Methods inherited from class com.sun.jna.Structure

allocateMemory, allocateMemory, autoAllocate, autoRead, autoRead, autoWrite, autoWrite, cacheTypeInfo, calculateSize, clear, createFieldsOrder, createFieldsOrder, createFieldsOrder, createFieldsOrder, dataEquals, dataEquals, ensureAllocated, equals, fieldOffset, getAutoRead, getAutoWrite, getFieldList, getFieldOrder, getFields, getNativeAlignment, getNativeSize, getNativeSize, getPointer, getStringEncoding, getStructAlignment, hashCode, newInstance, newInstance, readField, readField, setAlignType, setAutoRead, setAutoSynch, setAutoWrite, setFieldOrder, setStringEncoding, size, sortFields, toString, toString, useMemory, useMemory, writeField, writeField, writeField

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.ochafik.lang.jnaerator.runtime.StructureType

getPointer, size

Field Detail

userdata

public com.sun.jna.Pointer userdata

User-provided data. User is free to set anything he wants here
C type : void*

data

public SshLibrary.ssh_callback_data data

This function will be called each time data appears on socket. The data
not consumed will appear on the next data event.
C type : ssh_callback_data

controlflow

public SshLibrary.ssh_callback_int controlflow

This function will be called each time a controlflow state changes, i.e.
the socket is available for reading or writing.
C type : ssh_callback_int

exception

public SshLibrary.ssh_callback_int_int exception

This function will be called each time an exception appears on socket. An
exception can be a socket problem (timeout, ...) or an end-of-file.
C type : ssh_callback_int_int

connected

public SshLibrary.ssh_callback_int_int connected

This function is called when the ssh_socket_connect was used on the socket
on nonblocking state, and the connection successed.
C type : ssh_callback_int_int

Constructor Detail

ssh_socket_callbacks_struct

public ssh_socket_callbacks_struct()

ssh_socket_callbacks_struct

public ssh_socket_callbacks_struct(com.sun.jna.Pointer userdata,
                                   SshLibrary.ssh_callback_data data,
                                   SshLibrary.ssh_callback_int controlflow,
                                   SshLibrary.ssh_callback_int_int exception,
                                   SshLibrary.ssh_callback_int_int connected)

Parameters:

userdata - User-provided data. User is free to set anything he wants here
C type : void*

data - This function will be called each time data appears on socket. The data
not consumed will appear on the next data event.
C type : ssh_callback_data

controlflow - This function will be called each time a controlflow state changes, i.e.
the socket is available for reading or writing.
C type : ssh_callback_int

exception - This function will be called each time an exception appears on socket. An
exception can be a socket problem (timeout, ...) or an end-of-file.
C type : ssh_callback_int_int

connected - This function is called when the ssh_socket_connect was used on the socket
on nonblocking state, and the connection successed.
C type : ssh_callback_int_int

Method Detail

initFieldOrder

protected void initFieldOrder()

newByReference

protected ssh_socket_callbacks_struct.ByReference newByReference()

Specified by:

newByReference in class com.ochafik.lang.jnaerator.runtime.Structure<ssh_socket_callbacks_struct,ssh_socket_callbacks_struct.ByValue,ssh_socket_callbacks_struct.ByReference>

newByValue

protected ssh_socket_callbacks_struct.ByValue newByValue()

Specified by:

newByValue in class com.ochafik.lang.jnaerator.runtime.Structure<ssh_socket_callbacks_struct,ssh_socket_callbacks_struct.ByValue,ssh_socket_callbacks_struct.ByReference>

newInstance

protected ssh_socket_callbacks_struct newInstance()

Specified by:

newInstance in class com.ochafik.lang.jnaerator.runtime.Structure<ssh_socket_callbacks_struct,ssh_socket_callbacks_struct.ByValue,ssh_socket_callbacks_struct.ByReference>

newArray

public static ssh_socket_callbacks_struct[] newArray(int arrayLength)