xssh/ssh_channel_core

bool xrtSshChannelCoreOpenInit( xsshchannelcore* pChannel, uint32 iLocal, uint32 iReceiveWindow, uint32 iReceiveMaxPacket, uint32 iAdjustThreshold );

sshchannelcoreopeninit obj;
xrtSshChannelCoreOpenInit(&obj, pChannel, iLocal, iReceiveWindow, iReceiveMaxPacket, iAdjustThreshold);

bool xrtSshChannelCoreAcceptInit( xsshchannelcore* pChannel, uint32 iLocal, const xsshchannelopen* pOpen, uint32 iReceiveWindow, uint32 iReceiveMaxPacket, uint32 iAdjustThreshold );

sshchannelcoreacceptinit obj;
xrtSshChannelCoreAcceptInit(&obj, pChannel, iLocal, pOpen, iReceiveWindow, iReceiveMaxPacket, iAdjustThreshold);

void xrtSshChannelCoreClear(xsshchannelcore* pChannel);

/* 清除 channel core；不会清理调用方数据或 request reply 队列。 */
result = xrtSshChannelCoreClear(pChannel);

xsshchannelcorephase xrtSshChannelCorePhase( const xsshchannelcore* pChannel );

/* 返回公开 channel 阶段；无效对象返回 FAILED。 */
result = xrtSshChannelCorePhase(pChannel);

bool xrtSshChannelCoreIds( const xsshchannelcore* pChannel, uint32* pLocal, uint32* pRemote );

/* 返回本端 channel id；远端 id 仅在 accepting/open/closed 阶段可用。 */
result = xrtSshChannelCoreIds(pChannel, pLocal, pRemote);

xsshcode xrtSshChannelCoreConfirmationCommit( xsshchannelcore* pChannel, const xsshchannelconfirmation* pConfirmation );

/* 提交 peer 对本端 open 的 confirmation，并原子开放数据面。 */
result = xrtSshChannelCoreConfirmationCommit(pChannel, pConfirmation);

xsshcode xrtSshChannelCoreFailureCommit( xsshchannelcore* pChannel, const xsshchannelopenfailure* pFailure );

/* 提交 peer 对本端 open 的 failure，并保留失败 reason。 */
result = xrtSshChannelCoreFailureCommit(pChannel, pFailure);

xsshcode xrtSshChannelCoreAcceptCommit(xsshchannelcore* pChannel);

/* 本端 confirmation 已可靠排队后提交 peer open。 */
result = xrtSshChannelCoreAcceptCommit(pChannel);

xsshcode xrtSshChannelCoreRejectCommit( xsshchannelcore* pChannel, uint32 iReason );

/* 本端 failure 已可靠排队后提交拒绝结果。 */
result = xrtSshChannelCoreRejectCommit(pChannel, iReason);

bool xrtSshChannelCoreOpen(const xsshchannelcore* pChannel);

/* 判断数据面是否已打开或双向 close 是否已经完成。 */
result = xrtSshChannelCoreOpen(pChannel);

;

/* XRT_API bool xrtSshChannelCoreClosed(const xsshchannelcore* pChannel); */
result = xrtSshChannelCoreClosed();

uint32 xrtSshChannelCoreSendLimit( const xsshchannelcore* pChannel );

/* 返回下一条 data/extended-data payload 可发送的最大字节数。 */
result = xrtSshChannelCoreSendLimit(pChannel);

xsshcode xrtSshChannelCoreDataSendCommit( xsshchannelcore* pChannel, uint32 iBytes );

/* data 可靠排队后扣减远端窗口；EOF/CLOSE 后拒绝新数据。 */
result = xrtSshChannelCoreDataSendCommit(pChannel, iBytes);

xsshcode xrtSshChannelCoreDataReceiveCommit( xsshchannelcore* pChannel, uint32 iRecipient, uint32 iBytes );

/* 提交已验证的 peer data，并校验本端 recipient、窗口和生命周期。 */
result = xrtSshChannelCoreDataReceiveCommit(pChannel, iRecipient, iBytes);

xsshcode xrtSshChannelCoreDataConsume( xsshchannelcore* pChannel, uint32 iBytes );

/* 应用消费已接收数据；close 后仍可释放此前缓冲的数据。 */
result = xrtSshChannelCoreDataConsume(pChannel, iBytes);

bool xrtSshChannelCoreAdjustReady( const xsshchannelcore* pChannel );

/* 判断是否应发送 WINDOW_ADJUST，并返回当前可安全返还额度。 */
result = xrtSshChannelCoreAdjustReady(pChannel);

;

/* XRT_API uint32 xrtSshChannelCoreAdjustLimit( const xsshchannelcore* pChannel ); */
result = xrtSshChannelCoreAdjustLimit();

xsshcode xrtSshChannelCoreAdjustSendCommit( xsshchannelcore* pChannel, uint32 iBytes );

/* WINDOW_ADJUST 可靠排队后提交本端返还额度。 */
result = xrtSshChannelCoreAdjustSendCommit(pChannel, iBytes);

xsshcode xrtSshChannelCoreAdjustReceiveCommit( xsshchannelcore* pChannel, const xsshchanneladjust* pAdjust );

/* 提交已验证的 peer WINDOW_ADJUST。 */
result = xrtSshChannelCoreAdjustReceiveCommit(pChannel, pAdjust);

bool xrtSshChannelCoreCanSendRequest( const xsshchannelcore* pChannel );

/* 判断当前方向是否还能发送或接收 channel request。 */
result = xrtSshChannelCoreCanSendRequest(pChannel);

;

/* XRT_API bool xrtSshChannelCoreCanReceiveRequest( const xsshchannelcore* pChannel ); */
result = xrtSshChannelCoreCanReceiveRequest();

xsshcode xrtSshChannelCoreRecipientCheck( const xsshchannelcore* pChannel, uint32 iRecipient );

/* 校验已解析 peer channel 消息的 recipient，不推进状态。 */
result = xrtSshChannelCoreRecipientCheck(pChannel, iRecipient);

xsshcode xrtSshChannelCoreEofSendCommit( xsshchannelcore* pChannel );

/* EOF 可靠排队或验证接收后提交对应方向的半关闭。 */
result = xrtSshChannelCoreEofSendCommit(pChannel);

;

/* XRT_API xsshcode xrtSshChannelCoreEofReceiveCommit( xsshchannelcore* pChannel, uint32 iRecipient ); */
result = xrtSshChannelCoreEofReceiveCommit();

xsshcode xrtSshChannelCoreCloseSendCommit( xsshchannelcore* pChannel );

/* CLOSE 可靠排队或验证接收后提交；双向完成时进入 CLOSED。 */
result = xrtSshChannelCoreCloseSendCommit(pChannel);

;

/* XRT_API xsshcode xrtSshChannelCoreCloseReceiveCommit( xsshchannelcore* pChannel, uint32 iRecipient ); */
result = xrtSshChannelCoreCloseReceiveCommit();