kmcifs-client/com.sorrowblue.kmcifs.client

Package-level declarations

Types

class SmbClient : AutoCloseable

Manages an SMB2/SMB3 client session over a single TCP connection with asynchronous request pipelining and MessageId-based response demultiplexing.

SmbConfig

data class SmbConfig(val dialects: List<SmbDialect> = listOf( SmbDialect.SMB_3_1_1, SmbDialect.SMB_3_0_2, SmbDialect.SMB_3_0_0, SmbDialect.SMB_2_1_0, SmbDialect.SMB_2_0_2, ), val ciphers: List<SmbCipherId> = listOf( SmbCipherId.AES_128_GCM, SmbCipherId.AES_128_CCM, ), val encryptionPolicy: SmbEncryptionPolicy = SmbEncryptionPolicy.NEGOTIATE, val preferEncryption: Boolean = false, val alwaysSign: Boolean = false, val verifyServerSignatures: Boolean = true, val queryDirectoryBufferSize: Int = 64 * 1024, val randomAccessBufferSize: Int = SmbRandomAccessFile.DEFAULT_BUFFER_SIZE, val connectTimeout: Duration = 10.seconds, val requestTimeout: Duration = 30.seconds)

Configuration options for an SmbClient connection.

SmbEncryptionPolicy

enum class SmbEncryptionPolicy : Enum<SmbEncryptionPolicy>

Policy for applying SMB3 packet encryption (SMB2_TRANSFORM_HEADER).

SmbEndOfFileException

class SmbEndOfFileException(message: String = "End of SMB file reached") : Exception

Exception thrown when an attempt is made to read past the end of an SMB file (EOF).

SmbFile

class SmbFile : AutoCloseable

Represents an open handle to a remote SMB file.

SmbNamedPipe

class SmbNamedPipe : AutoCloseable

Represents an open handle to an SMB named pipe.

SmbPipeShare

class SmbPipeShare : AutoCloseable

Represents a tree connection to the IPC$ share for named pipe operations.

SmbRandomAccessFile

class SmbRandomAccessFile(val share: SmbShare, val path: String, val mode: SmbRandomAccessMode = SmbRandomAccessMode.READ_ONLY, val bufferSize: Int = DEFAULT_BUFFER_SIZE) : AutoCloseable

Provides a java.io.RandomAccessFile-compatible random-access API over a remote SMB file.

SmbRandomAccessMode

enum class SmbRandomAccessMode : Enum<SmbRandomAccessMode>

Open mode for SmbRandomAccessFile.

SmbShare

class SmbShare : AutoCloseable

Provides file and directory operations on a connected SMB shared folder (SMB2 TREE_CONNECT).