java.nio.channels
인터페이스 GatheringByteChannel

모든 슈퍼 인터페이스:

Channel , WritableByteChannel

기존의 구현 클래스의 일람:

DatagramChannel , FileChannel , Pipe.SinkChannel , SocketChannel

public interface GatheringByteChannel

extends WritableByteChannel

버퍼 순차 순서로부터 바이트를 기입할 수가 있는 채널입니다.

「집중」기입 조작은 1 회의 호출로, 지정된 버퍼 순차 순서 (복수가능)로부터 단일의 바이트 순차 순서를 기입합니다. 통상, 집중 기입은 특정의 네트워크 프로토콜이나 파일 형식 (데이터를 1 개 이상의 고정장 헤더와 가변장의 본체로부터 되는 세그먼트(segment)에 정리하는 기능을 가지는 것 등)을 구현하는 경우에 도움이 됩니다. 이것에 유사한 「분산」read 조작은 ScatteringByteChannel 인터페이스에 정의되고 있습니다.

도입된 버젼:

1.4

메소드의 개요

long	write (ByteBuffer [] srcs) 이 채널의 바이트 순차 순서가 지정된 버퍼로부터 써냅니다.
long	write (ByteBuffer [] srcs, int offset, int length) 이 채널의 바이트 순차 순서가 지정된 버퍼의 서브 순차 순서로부터 써냅니다.

인터페이스 java.nio.channels. WritableByteChannel 에서 상속받은 메소드

write

인터페이스 java.nio.channels. Channel 에서 상속받은 메소드

close , isOpen

메소드의 상세

write

public long write(ByteBuffer [] srcs,
                  int offset,
                  int length)
           throws IOException 

이 채널의 바이트 순차 순서가 지정된 버퍼의 서브 순차 순서로부터 써냅니다.

이 채널에 최대 r 바이트를 기입하려고 합니다. r 는 이 메소드의 호출시로 지정된 버퍼 배열의 지정된 서브 순차 순서에 포함되는 합계 바이트수입니다.

 srcs[offset]. remaining()
     + srcs[offset+1]. remaining()
     + ... + srcs[offset+length-1]. remaining()

길이 n (0 <= n <= r)의 바이트 순차 순서가 기입해진다고 합니다. 이 순차 순서의 최초의 srcs[offset]. remaining()바이트까지가 버퍼 srcs[offset] 에 기입해져 다음의 srcs[offset+1]. remaining() 바이트가 버퍼 srcs[offset] 로부터 버퍼 srcs[offset+1] 에 기입해집니다. 이 처리는 바이트 순차 순서 전부가 기입해질 때까지 반복해집니다. 각 버퍼로부터 최대한의 바이트가 기입해지기 (위해)때문에, 갱신된 개개의 버퍼의 최종적인 위치는 최종 갱신 버퍼를 제외해, 이 버퍼의 리밋트와 동일해집니다.

특히 지정이 없는 한, 요구된 r 바이트가 모두 기입해지면(자) 기입 조작은 종료합니다. 채널의 종류에 따라서는 그 상태에 응해, 일부의 바이트 밖에 기입해지지 않은 경우나, 전혀 기입을 하지 않는 경우도 있습니다. 예를 들어 비블록 모드의 소켓 채널에서는 소켓의 출력 버퍼내의 바이트수가 최대 기입 바이트수가 됩니다.

이 메소드는 언제라도 호출할 수 있습니다. 다만, 그 외의 thread가 이 채널에 대해서 기입해 조작을 개시하고 있는 경우, 이 메소드의 호출은 최초의 조작이 끝날 때까지 블록 됩니다.

파라미터:

srcs - 바이트의 취득처 버퍼

offset - 최초의 바이트의 취득처가 되는 버퍼 배열내의 오프셋(offset). srcs.length 이하의 제로 또는 정의 수

length - 액세스 가능한 최대 버퍼수. srcs.length - offset 이하의 제로 또는 정의 수

반환값:

기입해지는 바이트수. 제로의 경우도 있다

예외:

IndexOutOfBoundsException - offset 파라미터와 length 파라미터의 전제 조건이 채워지지 않은 경우

NonWritableChannelException - 이 채널이 기입해 가능하지 않은 경우

ClosedChannelException - 이 채널이 클로우즈 하고 있는 경우

AsynchronousCloseException - 기입중에, 다른 thread에 의해 이 채널이 클로우즈 되었을 경우

ClosedByInterruptException - 기입중에 다른 thread로부터의 세치기가 있었기 때문에 채널이 클로우즈 해, 현재의 thread의 세치기 상태가 설정되었을 경우

IOException - 그 외의 입출력 에러가 발생했을 경우

write

public long write(ByteBuffer [] srcs)
           throws IOException 

이 채널의 바이트 순차 순서가 지정된 버퍼로부터 써냅니다.

이 메소드를 c.write(srcs) 의 형식에서 호출했을 경우, 다음의 호출과 같은 결과를 얻을 수 있습니다.

 c.write(srcs, 0, srcs.length);

파라미터:

srcs - 바이트의 취득처 버퍼

반환값:

기입해지는 바이트수. 제로의 경우도 있다

예외:

NonWritableChannelException - 이 채널이 기입해 가능하지 않은 경우

ClosedChannelException - 이 채널이 클로우즈 하고 있는 경우

AsynchronousCloseException - 기입중에, 다른 thread에 의해 이 채널이 클로우즈 되었을 경우

ClosedByInterruptException - 기입중에 다른 thread로부터의 세치기가 있었기 때문에 채널이 클로우즈 해, 현재의 thread의 세치기 상태가 설정되었을 경우

IOException - 그 외의 입출력 에러가 발생했을 경우